module:api/PaymentApi(apiClientopt)

new module:api/PaymentApi(apiClientopt)

This class subject to change without prior notice, Please dont use this class directly.

Constructs a new PaymentApi.
Parameters:
Name Type Attributes Description
apiClient module:ApiClient <optional>

Optional API client implementation to use, default to module:ApiClient#instance if unspecified.

Methods

createPayment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_customer, create_payment_request, opts, callback)

Create Payment The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference.<p>Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response.</p> <p> if payment_authorization.id is passed then the payment is charged from the amount that is hold as part of the create payment authorization API </p>

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.

create_payment_request module:models/CreatePaymentRequest

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/PaymentApi~createPaymentCallback

The callback function, accepting three arguments: error, data, response data is of type: module:models/PaymentResponse

deletePayment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, id_customer, delete_payment_request, opts, callback)

Delete Payment The API is used to delete or cancel a payment. Payments that are under processing or have already been processed cannot be deleted.

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_payment String

The unique identifier assigned by EBPP to the payment.

id_customer String

The unique identifier assigned by EBPP to the customer.

delete_payment_request module:models/DeletePaymentRequest

Details of payment to be deleted/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/PaymentApi~deletePaymentCallback

The callback function, accepting three arguments: error, data, response data is of type: module:models/DeleteResponse

deleteRecordPayment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, delete_recorded_payment_request, opts, callback)

Delete Recorded Payment The API is used to delete the recorded payment. 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_payment String

The unique identifier assigned by EBPP to the payment.

delete_recorded_payment_request module:models/DeleteRecordedPaymentRequest

Details of payment to be deleted/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/PaymentApi~deleteRecordPaymentCallback

The callback function, accepting three arguments: error, data, response

getPayment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, id_customer, opts, callback)

Get Payment The API is used to retrieve the details of a payment or a recorded payment by id.

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_payment String

The unique identifier assigned by EBPP to the payment.

id_customer String

The unique identifier assigned by EBPP to the customer.

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/PaymentApi~getPaymentCallback

The callback function, accepting three arguments: error, data, response data is of type: module:models/PaymentResponse

recordPayment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, record_payment_request, opts, callback)

Record Payment The API is used to record payments in EBPP those are made and fulfilled outside EBPP.

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.

record_payment_request module:models/RecordPaymentRequest

JSON containing all the fields required to record 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/PaymentApi~recordPaymentCallback

The callback function, accepting three arguments: error, data, response data is of type: module:models/RecordedPaymentResponse

retrieveFeePayment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_fee, id_customer, opts, callback)

Get Fee Payment The API is used to retrieve the details of a fee payment by id.

Parameters:
Name Type Description
channel String

The channel through which the API is invoked.

client_key String

The unique identifier assigned by OrbiPay 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_fee String

The unique identifier assigned by OrbiPay to the FeePayment.

id_customer String

The unique identifier assigned by OrbiPay to the customer.

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/PaymentApi~retrieveFeePaymentCallback

The callback function, accepting three arguments: error, data, response data is of type: module:models/PaymentResponse

retrievePayments(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, opts, callback)

Retrieve Payments The API is used to retrieve the payments and recorded payments made by a customer. Payments can be filtered using the confirmation number, customer account, funding account, status and payment schedule type, payment method, by date range and others mentioned below. If no dates are provided for retrieval, payments in the last six months and all the payments scheduled for a future date are returned. In case a payment has failed due to ACH returns, then the payment return date and the return code will be available in the response. The results are sorted in descending order of the payment_date followed by the last_modified_time.

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.

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.

id_customer String

The unique identifier assigned by EBPP to the customer.

id_funding_account String

The unique identifier assigned by EBPP to the funding account

id_customer_account String

The unique identifier assigned by EBPP to the customer account

confirmation_number String

The confirmation number or reference provided to the customer for the successful payment.

status Array.<module:models/String>

The status of the payment. This can take multiple values in the format key=value1&key=value2....

payment_schedule_type Array.<module:models/String>

The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2....

payment_method Array.<module:models/String>

The fulfillment method for the payment.

from_date String

The date from which payments, matching the criteria specified, need to be retrieved.

to_date String

The date upto which payments, matching the criteria specified, need to be retrieved.

page_size String

The maximum number of objects returned in the query.

query_id String

query id of the Retrieve/Search Customers lookup.

from_index String

To fetch the next set of objects that start after this object

to_index String

To fetch the previous set of objects that end at this object

callback module:api/PaymentApi~retrievePaymentsCallback

The callback function, accepting three arguments: error, data, response data is of type: module:models/PaymentsResponse

simplePayment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, simple_payment_request, opts, callback)

Simple Payment The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference. Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in EBPP are add_to_principal and bill_separately. Alternatively, the fee information can be setup in EBPP, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response. This API updates the details of the customer, customer account and the funding account if those exist in EBPP or creates them otherwise.

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.

simple_payment_request module:models/SimplePaymentRequest

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.

save_funding_account module:models/String

query param

callback module:api/PaymentApi~simplePaymentCallback

The callback function, accepting three arguments: error, data, response data is of type: module:models/SimplePaymentResponse

updatePayment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, id_payment, id_customer, update_payment_request, opts, callback)

Update Payment The API is used to edit a payment. Only payments in scheduled status can be edited.

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_payment String

The unique identifier assigned by EBPP to the payment.

id_customer String

The unique identifier assigned by EBPP to the customer.

update_payment_request module:models/UpdatePaymentRequest

Details of the Payment to be updated.

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/PaymentApi~updatePaymentCallback

The callback function, accepting three arguments: error, data, response data is of type: module:models/PaymentResponse

Type Definitions

createPaymentCallback(error, data, response)

Callback function to receive the result of the createPayment operation.

Parameters:
Name Type Description
error String

Error message, if any.

data module:models/PaymentResponse

The data returned by the service call.

response String

The complete HTTP response.

deletePaymentCallback(error, data, response)

Callback function to receive the result of the deletePayment operation.

Parameters:
Name Type Description
error String

Error message, if any.

data module:models/DeleteResponse

The data returned by the service call.

response String

The complete HTTP response.

deleteRecordPaymentCallback(error, data, response)

Callback function to receive the result of the deleteRecordPayment 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.

getPaymentCallback(error, data, response)

Callback function to receive the result of the getPayment operation.

Parameters:
Name Type Description
error String

Error message, if any.

data module:models/PaymentResponse

The data returned by the service call.

response String

The complete HTTP response.

recordPaymentCallback(error, data, response)

Callback function to receive the result of the recordPayment operation.

Parameters:
Name Type Description
error String

Error message, if any.

data module:models/RecordedPaymentResponse

The data returned by the service call.

response String

The complete HTTP response.

retrieveFeePaymentCallback(error, data, response)

Callback function to receive the result of the retrieveFeePayment operation.

Parameters:
Name Type Description
error String

Error message, if any.

data module:models/PaymentResponse

The data returned by the service call.

response String

The complete HTTP response.

retrievePaymentsCallback(error, data, response)

Callback function to receive the result of the retrievePayments operation.

Parameters:
Name Type Description
error String

Error message, if any.

data module:models/PaymentsResponse

The data returned by the service call.

response String

The complete HTTP response.

simplePaymentCallback(error, data, response)

Callback function to receive the result of the simplePayment operation.

Parameters:
Name Type Description
error String

Error message, if any.

data module:models/SimplePaymentResponse

The data returned by the service call.

response String

The complete HTTP response.

updatePaymentCallback(error, data, response)

Callback function to receive the result of the updatePayment operation.

Parameters:
Name Type Description
error String

Error message, if any.

data module:models/PaymentResponse

The data returned by the service call.

response String

The complete HTTP response.