V1.12.0 Changelog
Added
Modified (Older values highlighted with strikethrough)
Deprecated
Removed
EBPP API
-
Added new status incollections to CustomerAccount resource.
-
Added apple pay support.
Customer
Create Customer
Specification Changes
- Response Body
-
customer_accounts.list[n].status string
- The status of the customer's account in EBPP.
- Valid Values : incollections, active, inactive
-
Update Customer
Specification Changes
- Request Body
-
customer_accounts[n].status string
- The status of the customer's account in EBPP.
- Valid Values : incollections, active, inactive
-
- Response Body
-
customer_accounts.list[n].status string
- The status of the customer's account in EBPP.
- Valid Values : incollections, active, inactive
-
Get Customer
Specification Changes
- Response Body
-
customer_accounts.list[n].status string
- The status of the customer's account in EBPP.
- Valid Values : incollections, active, inactive
-
Customer Account
Retrieve Customer Accounts
Specification Changes
- Form Params
-
status[n] array
- The status of the customer's account in EBPP. This can take multiple values in the format key=value1&key=value2....
- Valid Values : incollections, active, inactive
-
- Response Body
-
list[n].status string
- The status of the customer's account in EBPP.
- Valid Values : incollections, 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 : incollections, active, inactive
-
Funding Account
Add Funding Account
Specification Changes
- Response Body
-
display_text string
- UI representation of the account.
- Reg. Exp.: [a-zA-Z0-9 *]{1,20}
-
account_subtype string
- The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/Bank/ApplePay account. For e.g., a savings account, a checking account.
- Valid Values : apple_pay, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit
-
account_type string
- The type of the funding account.
- Valid Values : wallet, bank, debit_card, credit_card
-
Update Funding Account
Specification Changes
- Response Body
-
display_text string
- UI representation of the account.
- Reg. Exp.: [a-zA-Z0-9 *]{1,20}
-
account_subtype string
- The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/Bank/ApplePay account. For e.g., a savings account, a checking account.
- Valid Values : apple_pay, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit
-
account_type string
- The type of the funding account.
- Valid Values : wallet, bank, debit_card, credit_card
-
Get Funding Account
Specification Changes
- Response Body
-
display_text string
- UI representation of the account.
- Reg. Exp.: [a-zA-Z0-9 *]{1,20}
-
account_subtype string
- The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/Bank/ApplePay account. For e.g., a savings account, a checking account.
- Valid Values : apple_pay, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit
-
account_type string
- The type of the funding account.
- Valid Values : wallet, bank, debit_card, credit_card
-
Retrieve Funding Accounts
Specification Changes
- Response Body
-
list[n].display_text string
- UI representation of the account.
- Reg. Exp.: [a-zA-Z0-9 *]{1,20}
-
list[n].account_subtype string
- The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/Bank/ApplePay account. For e.g., a savings account, a checking account.
- Valid Values : apple_pay, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit
-
list[n].account_type string
- The type of the funding account.
- Valid Values : wallet, bank, debit_card, credit_card
-
Replace Funding Account
Specification Changes
- Response Body
-
display_text string
- UI representation of the account.
- Reg. Exp.: [a-zA-Z0-9 *]{1,20}
-
account_subtype string
- The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/Bank/ApplePay account. For e.g., a savings account, a checking account.
- Valid Values : apple_pay, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit
-
account_type string
- The type of the funding account.
- Valid Values : wallet, bank, debit_card, credit_card
-
Payment
Create Payment
Specification Changes
- Response Body
-
funding_account.display_text string
- UI representation of the account.
- Reg. Exp.: [a-zA-Z0-9 *]{1,20}
-
funding_account.account_holder_name string
- The name as specified on the account.
- Max. Length: 60 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+
-
payment_method string
- The fulfillment method for the payment.
- Valid Values : apple_pay, ach, check, visa_debit, pinless_debit, master_debit, amex_credit, discover_credit, visa_credit, master_credit, discover_debit, cash, swiped_card, scanned_check
-
funding_account.account_type string
- The type of the funding account.
- Valid Values : wallet, bank, debit_card, credit_card
-
funding_account.account_subtype string
- The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/Bank/ApplePay account.
- Valid Values : apple_pay, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit
-
Update Payment
Specification Changes
- Response Body
-
funding_account.display_text string
- UI representation of the account.
- Reg. Exp.: [a-zA-Z0-9 *]{1,20}
-
funding_account.account_holder_name string
- The name as specified on the account.
- Max. Length: 60 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+
-
payment_method string
- The fulfillment method for the payment.
- Valid Values : apple_pay, ach, check, visa_debit, pinless_debit, master_debit, amex_credit, discover_credit, visa_credit, master_credit, discover_debit, cash, swiped_card, scanned_check
-
funding_account.account_type string
- The type of the funding account.
- Valid Values : wallet, bank, debit_card, credit_card
-
funding_account.account_subtype string
- The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/Bank/ApplePay account.
- Valid Values : apple_pay, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit
-
Get Payment
Specification Changes
- Response Body
-
funding_account.display_text string
- UI representation of the account.
- Reg. Exp.: [a-zA-Z0-9 *]{1,20}
-
funding_account.account_holder_name string
- The name as specified on the account.
- Max. Length: 60 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+
-
payment_method string
- The fulfillment method for the payment.
- Valid Values : apple_pay, ach, check, visa_debit, pinless_debit, master_debit, amex_credit, discover_credit, visa_credit, master_credit, discover_debit, cash, swiped_card, scanned_check
-
funding_account.account_type string
- The type of the funding account.
- Valid Values : wallet, bank, debit_card, credit_card
-
funding_account.account_subtype string
- The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/Bank/ApplePay account.
- Valid Values : apple_pay, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit
-
Simple Payment
Specification Changes
- Request Body
-
funding_account.device_manufacturer_id string
- This is applicable only for Apple Pay transactions. Hex-encoded device manufacturer identifier.
- Reg. Exp.: [0-9]{12}
-
funding_account.display_text string
- UI representation of the account.
- Reg. Exp.: [a-zA-Z0-9 *]{1,20}
-
cryptogram string
- This is applicable only for Apple Pay transactions. Online Payment Cryptogram, as defined by 3-D secure.
- Reg. Exp.: [a-zA-Z0-9\-=+\/]{28}
-
eci string
- This is applicable only for Apple Pay transactions. ECI Indicator, as defined by 3-D secure. The card network may add an ECI indicator to the card data. This indicator is then included in the payment token. if you receive an ECI indicator, you must pass it on to your payment processor, otherwise, the transaction fails.
- Reg. Exp.: [0-9]{2}
-
funding_account.account_subtype string
- The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/Bank/ApplePay account. For e.g., a savings account, a checking account.
- Valid Values : apple_pay, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit
-
- Response Body
-
funding_account.display_text string
- UI representation of the account.
- Reg. Exp.: [a-zA-Z0-9 *]{1,20}
-
payment_method string
- The fulfillment method for the payment.
- Valid Values : apple_pay, ach, check, visa_debit, pinless_debit, master_debit, amex_credit, discover_credit, visa_credit, master_credit, cash, discover_debit
-
funding_account.account_subtype string
- The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/Bank/ApplePay account. For e.g., a savings account, a checking account.
- Valid Values : apple_pay, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit
-
funding_account.account_type string
- The type of the funding account.
- Valid Values : wallet, bank, debit_card, credit_card
-
customer_account.status string
- The status of the customer's account in EBPP.
- Valid Values : incollections, active, inactive
-
Retrieve Payments
Specification Changes
- Query Params
-
payment_method[n] array
- The fulfillment method for the payment.
- Valid Values : apple_pay, ach, check, visa_debit, pinless_debit, master_debit, amex_credit, discover_credit, visa_credit, master_credit, discover_debit, cash, swiped_card, scanned_check
-
- Response Body
-
list[n].funding_account.display_text string
- UI representation of the account.
- Reg. Exp.: [a-zA-Z0-9 *]{1,20}
-
list[n].funding_account.account_holder_name string
- The name as specified on the account.
- Max. Length: 60 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+
-
list[n].payment_method string
- The fulfillment method for the payment.
- Valid Values : apple_pay, ach, check, visa_debit, pinless_debit, master_debit, amex_credit, discover_credit, visa_credit, master_credit, discover_debit, cash, swiped_card, scanned_check
-
list[n].funding_account.account_type string
- The type of the funding account.
- Valid Values : wallet, bank, debit_card, credit_card
-
list[n].funding_account.account_subtype string
- The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/Bank/ApplePay account.
- Valid Values : apple_pay, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit
-
Get Fee Payment
Specification Changes
- Response Body
-
funding_account.display_text string
- UI representation of the account.
- Reg. Exp.: [a-zA-Z0-9 *]{1,20}
-
funding_account.account_holder_name string
- The name as specified on the account.
- Max. Length: 60 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+
-
payment_method string
- The fulfillment method for the payment.
- Valid Values : apple_pay, ach, check, visa_debit, pinless_debit, master_debit, amex_credit, discover_credit, visa_credit, master_credit, discover_debit, cash, swiped_card, scanned_check
-
funding_account.account_type string
- The type of the funding account.
- Valid Values : wallet, bank, debit_card, credit_card
-
funding_account.account_subtype string
- The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/Bank/ApplePay account.
- Valid Values : apple_pay, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit
-
Payment Setup
Create Payment Setup
Specification Changes
- Response Body
-
funding_account.display_text string
- UI representation of the account.
- Reg. Exp.: [a-zA-Z0-9 *]{1,20}
-
funding_account.account_holder_name string
- The name as specified on the account.
- Max. Length: 60 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+
-
funding_account.account_type string
- The type of the funding account.
- Valid Values : wallet, bank, debit_card, credit_card
-
funding_account.account_subtype string
- The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/Bank/ApplePay account.
- Valid Values : apple_pay, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit
-
Update Payment Setup
Specification Changes
- Response Body
-
funding_account.display_text string
- UI representation of the account.
- Reg. Exp.: [a-zA-Z0-9 *]{1,20}
-
funding_account.account_holder_name string
- The name as specified on the account.
- Max. Length: 60 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+
-
funding_account.account_type string
- The type of the funding account.
- Valid Values : wallet, bank, debit_card, credit_card
-
funding_account.account_subtype string
- The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/Bank/ApplePay account.
- Valid Values : apple_pay, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit
-
Get Payment Setup
Specification Changes
- Response Body
-
funding_account.display_text string
- UI representation of the account.
- Reg. Exp.: [a-zA-Z0-9 *]{1,20}
-
funding_account.account_holder_name string
- The name as specified on the account.
- Max. Length: 60 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+
-
funding_account.account_type string
- The type of the funding account.
- Valid Values : wallet, bank, debit_card, credit_card
-
funding_account.account_subtype string
- The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/Bank/ApplePay account.
- Valid Values : apple_pay, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit
-
Retrieve Payment Setups
Specification Changes
- Response Body
-
list[n].funding_account.display_text string
- UI representation of the account.
- Reg. Exp.: [a-zA-Z0-9 *]{1,20}
-
list[n].funding_account.account_holder_name string
- The name as specified on the account.
- Max. Length: 60 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+
-
list[n].funding_account.account_type string
- The type of the funding account.
- Valid Values : wallet, bank, debit_card, credit_card
-
list[n].funding_account.account_subtype string
- The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/Bank/ApplePay account.
- Valid Values : apple_pay, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit
-
Refund
Create Refund
Specification Changes
- Response Body
-
source_payment.funding_account.display_text string
- UI representation of the account.
- Reg. Exp.: [a-zA-Z0-9 *]{1,20}
-
source_payment.funding_account.account_holder_name string
- The name as specified on the account.
- Max. Length: 60 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+
-
source_payment.funding_account.account_type string
- The type of the funding account.
- Valid Values : wallet, bank, debit_card, credit_card
-
source_payment.funding_account.account_subtype string
- The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/Bank/ApplePay account.
- Valid Values : apple_pay, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit
-
Retrieve Refunds
Specification Changes
- Response Body
-
list[n].source_payment.funding_account.display_text string
- UI representation of the account.
- Reg. Exp.: [a-zA-Z0-9 *]{1,20}
-
list[n].source_payment.funding_account.account_holder_name string
- The name as specified on the account.
- Max. Length: 60 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+
-
list[n].source_payment.funding_account.account_type string
- The type of the funding account.
- Valid Values : wallet, bank, debit_card, credit_card
-
list[n].source_payment.funding_account.account_subtype string
- The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/Bank/ApplePay account.
- Valid Values : apple_pay, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit
-
Get Refund
Specification Changes
- Response Body
-
source_payment.funding_account.display_text string
- UI representation of the account.
- Reg. Exp.: [a-zA-Z0-9 *]{1,20}
-
source_payment.funding_account.account_holder_name string
- The name as specified on the account.
- Max. Length: 60 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+
-
source_payment.funding_account.account_type string
- The type of the funding account.
- Valid Values : wallet, bank, debit_card, credit_card
-
source_payment.funding_account.account_subtype string
- The sub type of the funding account. This is derived by EBPP in the case of card funding accounts. It needs to be passed when adding or editing a DDA/Bank/ApplePay account.
- Valid Values : apple_pay, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit
-