Methods

managePBTEnrollment(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, requestor, manage_pbt_request, opts, callback)

api/PaymentEnrollmentApi.js, line 62

Manage PBT Enrollment This API allows the management of Pay-By-Text (PBT) enrollment for a given customer by providing details such as phone number, customer account, funding account, and enrollment status. The API supports three main functionalities, which are create new enrollment, update existing enrollment or unenroll existing enrollment

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.
requestor	String	The identifier for the requestor of the API.
manage_pbt_request	module:models/ManagePBTRequest	JSON containing all the fields required to manage a customer for PBT enrollment.
opts	Object	Optional parameters Properties Name Type Description 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/PaymentEnrollmentApi~managePBTEnrollmentCallback	The callback function, accepting three arguments: error, data, response data is of type: module:models/PBTEnrollmentResponse

retrievePBTs(channel, client_key, product, timestamp, idempotent_request_key, requestor_type, requestor, id_customer, opts, callback)

api/PaymentEnrollmentApi.js, line 122

Retrieve PBT Enrollments The API can be utilized to retrieve the enrollment details of Pay by Text (PBT) for a specified customer based on search criteria.

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.
requestor	String	The identifier for the requestor of the API.
id_customer	String	The unique identifier assigned by EBPP to the customer.
opts	Object	Optional parameters Properties Name Type Description 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_account String The unique identifier assigned by EBPP to the customer account
callback	module:api/PaymentEnrollmentApi~retrievePBTsCallback	The callback function, accepting three arguments: error, data, response data is of type: module:models/PBTEnrollmentsResponse

Type Definitions

managePBTEnrollmentCallback(error, data, response)

api/PaymentEnrollmentApi.js, line 37

Callback function to receive the result of the managePBTEnrollment operation.

Parameters:

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

retrievePBTsCallback(error, data, response)

api/PaymentEnrollmentApi.js, line 96

Callback function to receive the result of the retrievePBTs operation.

Parameters:

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