V1.10.0 Changelog
Added
Modified (Older values highlighted with strikethrough)
Deprecated
Removed
EBPP API
Customer
Create Customer
Specification Changes
- Response Body
-
status string
- The status of the customer in EBPP.
- Valid Values : disabled, voluntary_cancellation, inactive, active, revoked, suspended
-
customer_accounts.list[n].status string
- The status of the customer's account in EBPP.
- Valid Values : suspended, deleted, unverified, unusable, active, inactive
-
Update Customer
Specification Changes
- Request Body
-
status string
- The status of the customer in EBPP.
- Valid Values : disabled, voluntary_cancellation, inactive, active, revoked, suspended
-
customer_accounts[n].status string
- The status of the customer's account in EBPP.
- Valid Values : suspended, deleted, unverified, unusable, active, inactive
-
- Response Body
-
status string
- The status of the customer in EBPP.
- Valid Values : disabled, voluntary_cancellation, inactive, active, revoked, suspended
-
customer_accounts.list[n].status string
- The status of the customer's account in EBPP.
- Valid Values : suspended, deleted, unverified, unusable, active, inactive
-
Get Customer
Specification Changes
- Response Body
-
status string
- The status of the customer in EBPP.
- Valid Values : disabled, voluntary_cancellation, inactive, active, revoked, suspended
-
customer_accounts.list[n].status string
- The status of the customer's account in EBPP.
- Valid Values : suspended, deleted, unverified, unusable, active, inactive
-
Retrieve Customers
Specification Changes
- Response Body
-
list[n].status string
- The status of the customer in EBPP.
- Valid Values : disabled, voluntary_cancellation, inactive, active, revoked, suspended
-
list[n].customer_accounts.list[n].status string
- The status of the customer's account in EBPP.
- Valid Values : suspended, deleted, unverified, unusable, active, inactive
-
Retrieve Customers Pagination
Specification Changes
- Response Body
-
list[n].status string
- The status of the customer in EBPP.
- Valid Values : disabled, voluntary_cancellation, inactive, active, revoked, suspended
-
list[n].customer_accounts.list[n].status string
- The status of the customer's account in EBPP.
- Valid Values : suspended, deleted, unverified, unusable, active, inactive
-
Customer Account
Retrieve Customer Accounts
Specification Changes
- Form Params
-
status array
- The status of the customer's account in EBPP. This can take multiple values in the format key=value1&key=value2....
- Valid Values : suspended, deleted, unverified, unusable, active, inactive
-
- Response Body
-
list[n].status string
- The status of the customer's account in EBPP.
- Valid Values : suspended, deleted, unverified, unusable, active, inactive
-
Retrieve Customer Accounts Pagination
Specification Changes
- Response Body
-
list[n].status string
- The status of the customer's account in EBPP.
- Valid Values : suspended, deleted, unverified, unusable, active, inactive
-
Funding Account
Add Funding Account
Specification Changes
- Response Body
-
status string
- The status of the funding account in EBPP.
- Valid Values : deleted, suspended, active, inactive, frozen, unverified, unusable
-
Update Funding Account
Specification Changes
- Request Body
-
status string
- The status of the funding account in EBPP.
- Valid Values : deleted, suspended, unusable, active, inactive, frozen, unverified
-
- Response Body
-
status string
- The status of the funding account in EBPP.
- Valid Values : deleted, suspended, active, inactive, frozen, unverified, unusable
-
Get Funding Account
Specification Changes
- Response Body
-
status string
- The status of the funding account in EBPP.
- Valid Values : deleted, suspended, active, inactive, frozen, unverified, unusable
-
Retrieve Funding Accounts
Specification Changes
- Form Params
-
status array
- The status of the funding account in EBPP. This can take multiple values in the format key=value1&key=value2....
- Valid Values : deleted, suspended, active, inactive, frozen, unverified, unusable
-
- Response Body
-
list[n].status string
- The status of the funding account in EBPP.
- Valid Values : deleted, suspended, active, inactive, frozen, unverified, unusable
-
Payment
Create Payment
Specification Changes
- Request Body
-
payment_notification_email string
- The email address to which notifications for the payment will be sent. The notifications will be sent to the customer's email in case this is not provided.
- Max. Length: 100 Reg. Exp.: [a-zA-Z0-9!#$%&'*+-/=?^._`{|}~]+@[a-zA-Z0-9_.-]+\.[a-zA-Z0-9._]+
-
- Response Body
-
payment_notification_email string
- The email address to which notifications for the payment will be sent. The notifications will be sent to the customer's email in case this is not provided.
- Max. Length: 100 Reg. Exp.: [a-zA-Z0-9!#$%&'*+-/=?^._`{|}~]+@[a-zA-Z0-9_.-]+\.[a-zA-Z0-9._]+
-
status string
- The status of the payment.
- Valid Values : error, refunded, scheduled, cancelled, processing, processed, returned, declined, disputed
-
Update Payment
Specification Changes
- Response Body
-
payment_notification_email string
- The email address to which notifications for the payment will be sent. The notifications will be sent to the customer's email in case this is not provided.
- Max. Length: 100 Reg. Exp.: [a-zA-Z0-9!#$%&'*+-/=?^._`{|}~]+@[a-zA-Z0-9_.-]+\.[a-zA-Z0-9._]+
-
status string
- The status of the payment.
- Valid Values : error, refunded, scheduled, cancelled, processing, processed, returned, declined, disputed
-
Get Payment
Specification Changes
- Response Body
-
payment_notification_email string
- The email address to which notifications for the payment will be sent. The notifications will be sent to the customer's email in case this is not provided.
- Max. Length: 100 Reg. Exp.: [a-zA-Z0-9!#$%&'*+-/=?^._`{|}~]+@[a-zA-Z0-9_.-]+\.[a-zA-Z0-9._]+
-
status string
- The status of the payment.
- Valid Values : error, refunded, scheduled, cancelled, processing, processed, returned, declined, disputed
-
Simple Payment
Specification Changes
- Request Body
-
payment_notification_email string
- The email address to which notifications for the payment will be sent. The notifications will be sent to the customer's email in case this is not provided.
- Max. Length: 100 Reg. Exp.: [a-zA-Z0-9!#$%&'*+-/=?^._`{|}~]+@[a-zA-Z0-9_.-]+\.[a-zA-Z0-9._]+
-
- Response Body
-
payment_notification_email string
- The email address to which notifications for the payment will be sent. The notifications will be sent to the customer's email in case this is not provided.
- Max. Length: 100 Reg. Exp.: [a-zA-Z0-9!#$%&'*+-/=?^._`{|}~]+@[a-zA-Z0-9_.-]+\.[a-zA-Z0-9._]+
-
status string
- The status of the payment.
- Valid Values : error, refunded, scheduled, cancelled, processing, processed, returned, declined, disputed
-
funding_account.status string
- The status of the funding account in EBPP.
- Valid Values : deleted, suspended, active, inactive, frozen, unverified, unusable
-
customer_account.status string
- The status of the customer's account in EBPP.
- Valid Values : suspended, deleted, unverified, unusable, active, inactive
-
Retrieve Payments
Specification Changes
- Query Params
-
status array
- The status of the payment. This can take multiple values in the format key=value1&key=value2....
- Valid Values : error, refunded, scheduled, cancelled, processing, processed, returned, declined, disputed
-
- Response Body
-
list[n].payment_notification_email string
- The email address to which notifications for the payment will be sent. The notifications will be sent to the customer's email in case this is not provided.
- Max. Length: 100 Reg. Exp.: [a-zA-Z0-9!#$%&'*+-/=?^._`{|}~]+@[a-zA-Z0-9_.-]+\.[a-zA-Z0-9._]+
-
list[n].status string
- The status of the payment.
- Valid Values : error, refunded, scheduled, cancelled, processing, processed, returned, declined, disputed
-
Get Fee Payment
Specification Changes
- Response Body
-
payment_notification_email string
- The email address to which notifications for the payment will be sent. The notifications will be sent to the customer's email in case this is not provided.
- Max. Length: 100 Reg. Exp.: [a-zA-Z0-9!#$%&'*+-/=?^._`{|}~]+@[a-zA-Z0-9_.-]+\.[a-zA-Z0-9._]+
-
status string
- The status of the payment.
- Valid Values : error, refunded, scheduled, cancelled, processing, processed, returned, declined, disputed
-
Payment Setup
Create Payment Setup
Specification Changes
- Response Body
-
status string
- The status of the payment.
- Valid Values : error, completed, processing, processed, returned, disputed, refunded, scheduled, cancelled, declined
-
Update Payment Setup
Specification Changes
- Response Body
-
status string
- The status of the payment.
- Valid Values : error, completed, processing, processed, returned, disputed, refunded, scheduled, cancelled, declined
-
Get Payment Setup
Specification Changes
- Response Body
-
status string
- The status of the payment.
- Valid Values : error, completed, processing, processed, returned, disputed, refunded, scheduled, cancelled, declined
-
Retrieve Payment Setups
Specification Changes
- Query Params
-
status array
- The status of the payment. This can take multiple values in the format key=value1&key=value2....
- Valid Values : error, completed, processing, processed, returned, disputed, refunded, scheduled, cancelled, declined
-
- Response Body
-
list[n].status string
- The status of the payment.
- Valid Values : error, completed, processing, processed, returned, disputed, refunded, scheduled, cancelled, declined
-
Refund
Create Refund
Specification Changes
- Response Body
-
status string
- The status of the refund.
- Valid Values : disputed, error, scheduled, cancelled, processing, processed, declined, returned
-
Retrieve Refunds
Specification Changes
- Query Params
-
status array
- The status of the refund. This can take multiple values in the format key=value1&key=value2....
- Valid Values : disputed, error, scheduled, cancelled, processing, processed, returned, declined
-
- Response Body
-
list[n].status string
- The status of the refund.
- Valid Values : disputed, error, scheduled, cancelled, processing, processed, declined, returned
-
Recorded Payment
Record Payment
Specification Changes
- Response Body
-
status string
- The status of the payment.
- Valid Values : processing, returned, refunded, processed, cancelled
-
customer_account.status string
- The status of the customer's account in EBPP.
- Valid Values : suspended, deleted, unverified, unusable, active, inactive
-
Retrieve Recorded Payments
Specification Changes
- Query Params
-
status array
- The status of the payment. This can take multiple values in the format key=value1&key=value2....
- Valid Values : scheduled, processing, returned, refunded, processed, cancelled
-
- Response Body
-
list[n].status string
- The status of the payment.
- Valid Values : processing, returned, refunded, processed, cancelled
-