Methods

cancelPaymentAuthorization(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, id_authorization, cancel_payment_authorization_request, opts, callback)

api/PaymentAuthorizationApi.js, line 63

Cancel Payment Authorization The API is used to cancel a payment authorization. Payment Authorizations that are already been processed into Payment cannot be cancelled. It returns 204 http status code with empty body in successful case.

Parameters:

Name	Type	Description
channel	String	The channel through which the API is invoked.
client_key	String	The unique identifier assigned by EBPP to the client.
product	module:models/String	The product identifier corresponding to the API.
timestamp	String	The timestamp for the moment when the API request is created.
idempotent_request_key	String	The unique token that clients can generate and maintain in order to identify an API request.
requestor_type	module:models/String	Type of the requestor of the API.
id_customer	String	The unique identifier assigned by EBPP to the customer.
id_authorization	String	The unique identifier assigned by EBPP to the payment authorization.
cancel_payment_authorization_request	module:models/CancelPaymentAuthorizationRequest	Details of payment authorization to be cancelled
opts	Object	Optional parameters Properties Name Type Description requestor String The identifier for the requestor of the API. x_opay_headers String Intended for the future use. trace_id String The unique reference that can be used for tracing and debugging an API call.
callback	module:api/PaymentAuthorizationApi~cancelPaymentAuthorizationCallback	The callback function, accepting three arguments: error, data, response

createPaymentAuthorization(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, create_payment_authorization_request, opts, callback)

api/PaymentAuthorizationApi.js, line 124

Create Payment Authorization The API is used to create a payment authorization with certain amount on a given card account. Client systems can provide the unique identifier for the payment authorization in their system as payment_auth_reference. As of now this API is supported only for voyager fleet card payments

Parameters:

Name	Type	Description
channel	String	The channel through which the API is invoked.
client_key	String	The unique identifier assigned by EBPP to the client.
product	module:models/String	The product identifier corresponding to the API.
timestamp	String	The timestamp for the moment when the API request is created.
idempotent_request_key	String	The unique token that clients can generate and maintain in order to identify an API request.
requestor_type	module:models/String	Type of the requestor of the API.
create_payment_authorization_request	module:models/CreatePaymentAuthorizationRequest	JSON containing all the fields required to make a payment.
opts	Object	Optional parameters Properties Name Type Description requestor String The identifier for the requestor of the API. x_opay_headers String Intended for the future use. trace_id String The unique reference that can be used for tracing and debugging an API call.
callback	module:api/PaymentAuthorizationApi~createPaymentAuthorizationCallback	The callback function, accepting three arguments: error, data, response data is of type: module:models/PaymentAuthorizationResponse

Type Definitions

cancelPaymentAuthorizationCallback(error, data, response)

api/PaymentAuthorizationApi.js, line 37

Callback function to receive the result of the cancelPaymentAuthorization operation.

Parameters:

Name	Type	Description
error	String	Error message, if any.
data		This operation does not return a value.
response	String	The complete HTTP response.

createPaymentAuthorizationCallback(error, data, response)

api/PaymentAuthorizationApi.js, line 99

Callback function to receive the result of the createPaymentAuthorization operation.

Parameters:

Name	Type	Description
error	String	Error message, if any.
data	module:models/PaymentAuthorizationResponse	The data returned by the service call.
response	String	The complete HTTP response.