V1.13.0 Changelog

  Added   Modified (Older values highlighted with strikethrough)   Deprecated   Removed

EBPP API

  • Payment Resource
    • Removed Get Recorded Payment API.
    • Removed Retrieve Recorded Payments API.
  • Payment Authorization Resource
    • Added Create Payment Authorization API.
      The API is used to create a payment authorization with a 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.
    • Added Cancel Payment Authorization API.
      The API is used to cancel a payment authorization. Payment Authorization for which the payment has already been processed cannot be cancelled.
    • Enhanced Create Payment API.
      The API is enhanced to create payment using the payment authorization id.

Customer

Create Customer

Specification Changes
  • Request Body
    • customer_accounts[n].status string
    • The status of the customer's account in EBPP and it is defaults to active.
    • Valid Values :    inbankruptcy, active, inactive, incollections
  • Response Body
    • customer_accounts.list[n].status string
    • The status of the customer's account in EBPP.
    • Valid Values :    inbankruptcy, active, inactive, incollections

Update Customer

Specification Changes
  • Request Body
    • customer_accounts[n].status string
    • The status of the customer's account in EBPP.
    • Valid Values :    inbankruptcy, active, inactive, incollections
  • Response Body
    • customer_accounts.list[n].status string
    • The status of the customer's account in EBPP.
    • Valid Values :    inbankruptcy, active, inactive, incollections

Get Customer

Specification Changes
  • Response Body
    • customer_accounts.list[n].status string
    • The status of the customer's account in EBPP.
    • Valid Values :    inbankruptcy, active, inactive, incollections

Retrieve Customers

Specification Changes
  • Response Body
    • list[n].customer_accounts.list[n].status string
    • The status of the customer's account in EBPP.
    • Valid Values :    inbankruptcy, active, inactive, incollections

Retrieve Customers Pagination

Specification Changes
  • Response Body
    • list[n].customer_accounts.list[n].status string
    • The status of the customer's account in EBPP.
    • Valid Values :    inbankruptcy, active, inactive, incollections

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 :    inbankruptcy, active, inactive, incollections
  • Response Body
    • list[n].status string
    • The status of the customer's account in EBPP.
    • Valid Values :    inbankruptcy, active, inactive, incollections

Retrieve Customer Accounts Pagination

Specification Changes
  • Response Body
    • list[n].status string
    • The status of the customer's account in EBPP.
    • Valid Values :    inbankruptcy, active, inactive, incollections

Get Customer Account

Specification Changes
  • Response Body
    • status string
    • The status of the customer's account in EBPP.
    • Valid Values :    inbankruptcy, active, inactive, incollections

Renew Customer Account

Specification Changes
  • Response Body
    • status string
    • The status of the customer's account in EBPP.
    • Valid Values :    inbankruptcy, active, inactive, incollections

Funding Account

Add Funding Account

Specification Changes
  • Request Body
    • account_subtype string
    • The sub type of the funding account.
    • Valid Values :    voyager_fleet, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit
  • Response Body
    • 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/GooglePay/Voyager account.
    • Valid Values :    google_pay,  voyager_fleet, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit, apple_pay
    • account_type string
    • The type of the funding account.
    • Valid Values :    closed_loop, bank, debit_card, credit_card, wallet

Update Funding Account

Specification Changes
  • Request Body
    • account_subtype string
    • The sub type of the funding account. This is derived by EBPP in the case of card funding accounts.
    • Valid Values :    voyager_fleet, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit
  • Response Body
    • 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/GooglePay/Voyager account.
    • Valid Values :    google_pay,  voyager_fleet, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit, apple_pay
    • account_type string
    • The type of the funding account.
    • Valid Values :    closed_loop, bank, debit_card, credit_card, wallet

Get Funding Account

Specification Changes
  • Response Body
    • 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/GooglePay/Voyager account.
    • Valid Values :    google_pay,  voyager_fleet, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit, apple_pay
    • account_type string
    • The type of the funding account.
    • Valid Values :    closed_loop, bank, debit_card, credit_card, wallet

Retrieve Funding Accounts

Specification Changes
  • Form Params
    • account_subtype string
    • The sub type of the funding account. This is derived by EBPP in the case of card funding accounts.
    • Valid Values :    voyager_fleet, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit
    • account_type[n] array
    • The type of the funding account. This can take multiple values in the format key=value1&key=value2....
    • Valid Values :    closed_loop, bank, debit_card, credit_card
  • Response Body
    • 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/GooglePay/Voyager account.
    • Valid Values :    google_pay,  voyager_fleet, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit, apple_pay
    • list[n].account_type string
    • The type of the funding account.
    • Valid Values :    closed_loop, bank, debit_card, credit_card, wallet

Replace Funding Account

Specification Changes
  • Request Body
    • account_subtype string
    • The sub type of the funding account. This is derived by EBPP in the case of card funding accounts.
    • Valid Values :    voyager_fleet, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit
  • Response Body
    • 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/GooglePay/Voyager account.
    • Valid Values :    google_pay,  voyager_fleet, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit, apple_pay
    • account_type string
    • The type of the funding account.
    • Valid Values :    closed_loop, bank, debit_card, credit_card, wallet

Payment

Create Payment

Specification Changes
  • Request Body
    • payment_authorization object
  • Response Body
    • payment_authorization object
    • The payment authorization on which the payment is being made.
    • payment_method string
    • The fulfillment method for the payment.
    • Valid Values :    google_pay,  voyager_fleet,  external_pos,  rtp_rfp, ach, check, visa_debit, pinless_debit, master_debit, amex_credit, discover_credit, visa_credit, master_credit, discover_debit, cash, swiped_card, scanned_check, apple_pay
    • funding_account.account_type string
    • The type of the funding account.
    • Valid Values :    closed_loop, bank, debit_card, credit_card, wallet
    • 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 :    google_pay,  voyager_fleet, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit, apple_pay

Update Payment

Specification Changes
  • Response Body
    • payment_authorization object
    • The payment authorization on which the payment is being made.
    • payment_method string
    • The fulfillment method for the payment.
    • Valid Values :    google_pay,  voyager_fleet,  external_pos,  rtp_rfp, ach, check, visa_debit, pinless_debit, master_debit, amex_credit, discover_credit, visa_credit, master_credit, discover_debit, cash, swiped_card, scanned_check, apple_pay
    • funding_account.account_type string
    • The type of the funding account.
    • Valid Values :    closed_loop, bank, debit_card, credit_card, wallet
    • 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 :    google_pay,  voyager_fleet, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit, apple_pay

Get Payment

Specification Changes
  • Response Body
    • payment_authorization object
    • The payment authorization on which the payment is being made.
    • payment_method string
    • The fulfillment method for the payment.
    • Valid Values :    google_pay,  voyager_fleet,  external_pos,  rtp_rfp, ach, check, visa_debit, pinless_debit, master_debit, amex_credit, discover_credit, visa_credit, master_credit, discover_debit, cash, swiped_card, scanned_check, apple_pay
    • funding_account.account_type string
    • The type of the funding account.
    • Valid Values :    closed_loop, bank, debit_card, credit_card, wallet
    • 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 :    google_pay,  voyager_fleet, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit, apple_pay

Simple Payment

Specification Changes
  • Request Body
    • funding_account.account_subtype string
    • The sub type of the funding account.
    • Valid Values :    google_pay,  voyager_fleet, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit, apple_pay
  • Response Body
    • payment_method string
    • The fulfillment method for the payment.
    • Valid Values :    google_pay,  voyager_fleet,  external_pos, ach, check, visa_debit, pinless_debit, master_debit, amex_credit, discover_credit, visa_credit, master_credit, cash, discover_debit, apple_pay
    • 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/GooglePay/Voyager account.
    • Valid Values :    google_pay,  voyager_fleet, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit, apple_pay
    • funding_account.account_type string
    • The type of the funding account.
    • Valid Values :    closed_loop, bank, debit_card, credit_card, wallet
    • customer_account.status string
    • The status of the customer's account in EBPP.
    • Valid Values :    inbankruptcy, active, inactive, incollections

Retrieve Payments

Specification Changes
  • Query Params
    • payment_method[n] array
    • The fulfillment method for the payment.
    • Valid Values :    google_pay,  voyager_fleet,  external_pos,  rtp_rfp, ach, check, visa_debit, pinless_debit, master_debit, amex_credit, discover_credit, visa_credit, master_credit, discover_debit, cash, swiped_card, scanned_check, apple_pay
  • Response Body
    • list[n].payment_authorization object
    • The payment authorization on which the payment is being made.
    • list[n].payment_method string
    • The fulfillment method for the payment.
    • Valid Values :    google_pay,  voyager_fleet,  external_pos,  rtp_rfp, ach, check, visa_debit, pinless_debit, master_debit, amex_credit, discover_credit, visa_credit, master_credit, discover_debit, cash, swiped_card, scanned_check, apple_pay
    • list[n].funding_account.account_type string
    • The type of the funding account.
    • Valid Values :    closed_loop, bank, debit_card, credit_card, wallet
    • 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 :    google_pay,  voyager_fleet, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit, apple_pay

Get Fee Payment

Specification Changes
  • Response Body
    • payment_authorization object
    • The payment authorization on which the payment is being made.
    • payment_method string
    • The fulfillment method for the payment.
    • Valid Values :    google_pay,  voyager_fleet,  external_pos,  rtp_rfp, ach, check, visa_debit, pinless_debit, master_debit, amex_credit, discover_credit, visa_credit, master_credit, discover_debit, cash, swiped_card, scanned_check, apple_pay
    • funding_account.account_type string
    • The type of the funding account.
    • Valid Values :    closed_loop, bank, debit_card, credit_card, wallet
    • 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 :    google_pay,  voyager_fleet, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit, apple_pay

Record Payment

Specification Changes
  • Response Body
    • customer_account.status string
    • The status of the customer's account in EBPP.
    • Valid Values :    inbankruptcy, active, inactive, incollections

Payment Setup

Create Payment Setup

Specification Changes
  • Response Body
    • funding_account.account_type string
    • The type of the funding account.
    • Valid Values :    closed_loop, bank, debit_card, credit_card, wallet
    • 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 :    google_pay,  voyager_fleet, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit, apple_pay

Update Payment Setup

Specification Changes
  • Response Body
    • funding_account.account_type string
    • The type of the funding account.
    • Valid Values :    closed_loop, bank, debit_card, credit_card, wallet
    • 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 :    google_pay,  voyager_fleet, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit, apple_pay

Get Payment Setup

Specification Changes
  • Response Body
    • funding_account.account_type string
    • The type of the funding account.
    • Valid Values :    closed_loop, bank, debit_card, credit_card, wallet
    • 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 :    google_pay,  voyager_fleet, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit, apple_pay

Retrieve Payment Setups

Specification Changes
  • Response Body
    • list[n].funding_account.account_type string
    • The type of the funding account.
    • Valid Values :    closed_loop, bank, debit_card, credit_card, wallet
    • 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 :    google_pay,  voyager_fleet, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit, apple_pay

Refund

Create Refund

Specification Changes
  • Response Body
    • source_payment.funding_account.account_type string
    • The type of the funding account.
    • Valid Values :    closed_loop, bank, debit_card, credit_card, wallet
    • 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 :    google_pay,  voyager_fleet, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit, apple_pay

Retrieve Refunds

Specification Changes
  • Response Body
    • list[n].source_payment.funding_account.account_type string
    • The type of the funding account.
    • Valid Values :    closed_loop, bank, debit_card, credit_card, wallet
    • 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 :    google_pay,  voyager_fleet, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit, apple_pay

Get Refund

Specification Changes
  • Response Body
    • source_payment.funding_account.account_type string
    • The type of the funding account.
    • Valid Values :    closed_loop, bank, debit_card, credit_card, wallet
    • 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 :    google_pay,  voyager_fleet, savings, checking, money_market, visa_credit, mastercard_credit, american_express_credit, discover_credit, visa_debit, mastercard_debit, discover_debit, apple_pay