V1.14.0 Changelog

  Added   Modified (Older values highlighted with strikethrough)   Deprecated   Removed

EBPP API

Customer

Create Customer

Specification Changes
  • Request Body
    • customer_accounts[n].payoff_amount string
    • This field contains the computed current loan payoff amount at the time of inquiry for the customer’s account with the biller.
    • Reg. Exp.: (\+|\-)?([0-9]{1,14}(\.[0-9][0-9]?)?)
    • customer_accounts[n].payoff_expiry_date string
    • The date till the payoff_amount is valid for the customer’s account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
    • Reg. Exp.: ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|1\d|2\d|3[01])$
    • customer_accounts[n].address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}
    • address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}
  • Response Body
    • customer_accounts.list[n].payoff_amount string
    • This field contains the computed current loan payoff amount at the time of inquiry for the customer’s account with the biller.
    • Reg. Exp.: (\+|\-)?([0-9]{1,14}(\.[0-9][0-9]?)?)
    • customer_accounts.list[n].payoff_expiry_date string
    • The date till the payoff_amount is valid for the customer’s account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
    • Reg. Exp.: ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|1\d|2\d|3[01])$
    • address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}
    • customer_accounts.list[n].address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}

Update Customer

Specification Changes
  • Request Body
    • customer_accounts[n].payoff_amount string
    • This field contains the computed current loan payoff amount at the time of inquiry for the customer’s account with the biller.
    • Reg. Exp.: (\+|\-)?([0-9]{1,14}(\.[0-9][0-9]?)?)
    • customer_accounts[n].payoff_expiry_date string
    • The date till the payoff_amount is valid for the customer’s account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
    • Reg. Exp.: ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|1\d|2\d|3[01])$
    • address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}
    • customer_accounts[n].address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}
  • Response Body
    • customer_accounts.list[n].payoff_amount string
    • This field contains the computed current loan payoff amount at the time of inquiry for the customer’s account with the biller.
    • Reg. Exp.: (\+|\-)?([0-9]{1,14}(\.[0-9][0-9]?)?)
    • customer_accounts.list[n].payoff_expiry_date string
    • The date till the payoff_amount is valid for the customer’s account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
    • Reg. Exp.: ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|1\d|2\d|3[01])$
    • address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}
    • customer_accounts.list[n].address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}

Get Customer

Specification Changes
  • Response Body
    • customer_accounts.list[n].payoff_amount string
    • This field contains the computed current loan payoff amount at the time of inquiry for the customer’s account with the biller.
    • Reg. Exp.: (\+|\-)?([0-9]{1,14}(\.[0-9][0-9]?)?)
    • customer_accounts.list[n].payoff_expiry_date string
    • The date till the payoff_amount is valid for the customer’s account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
    • Reg. Exp.: ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|1\d|2\d|3[01])$
    • address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}
    • customer_accounts.list[n].address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}

Retrieve Customers

Specification Changes
  • Response Body
    • list[n].customer_accounts.list[n].payoff_amount string
    • This field contains the computed current loan payoff amount at the time of inquiry for the customer’s account with the biller.
    • Reg. Exp.: (\+|\-)?([0-9]{1,14}(\.[0-9][0-9]?)?)
    • list[n].customer_accounts.list[n].payoff_expiry_date string
    • The date till the payoff_amount is valid for the customer’s account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
    • Reg. Exp.: ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|1\d|2\d|3[01])$
    • list[n].address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}
    • list[n].customer_accounts.list[n].address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}

Retrieve Customers Pagination

Specification Changes
  • Response Body
    • list[n].customer_accounts.list[n].payoff_amount string
    • This field contains the computed current loan payoff amount at the time of inquiry for the customer’s account with the biller.
    • Reg. Exp.: (\+|\-)?([0-9]{1,14}(\.[0-9][0-9]?)?)
    • list[n].customer_accounts.list[n].payoff_expiry_date string
    • The date till the payoff_amount is valid for the customer’s account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
    • Reg. Exp.: ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|1\d|2\d|3[01])$
    • list[n].address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}
    • list[n].customer_accounts.list[n].address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}

Customer Account

Retrieve Customer Accounts

Specification Changes
  • Response Body
    • list[n].payoff_amount string
    • This field contains the computed current loan payoff amount at the time of inquiry for the customer’s account with the biller.
    • Reg. Exp.: (\+|\-)?([0-9]{1,14}(\.[0-9][0-9]?)?)
    • list[n].payoff_expiry_date string
    • The date till the payoff_amount is valid for the customer’s account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
    • Reg. Exp.: ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|1\d|2\d|3[01])$
    • list[n].address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}

Retrieve Customer Accounts Pagination

Specification Changes
  • Response Body
    • list[n].payoff_amount string
    • This field contains the computed current loan payoff amount at the time of inquiry for the customer’s account with the biller.
    • Reg. Exp.: (\+|\-)?([0-9]{1,14}(\.[0-9][0-9]?)?)
    • list[n].payoff_expiry_date string
    • The date till the payoff_amount is valid for the customer’s account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
    • Reg. Exp.: ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|1\d|2\d|3[01])$
    • list[n].address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}

Get Customer Account

Specification Changes
  • Response Body
    • payoff_amount string
    • This field contains the computed current loan payoff amount at the time of inquiry for the customer’s account with the biller.
    • Reg. Exp.: (\+|\-)?([0-9]{1,14}(\.[0-9][0-9]?)?)
    • payoff_expiry_date string
    • The date till the payoff_amount is valid for the customer’s account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
    • Reg. Exp.: ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|1\d|2\d|3[01])$
    • address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}

Renew Customer Account

Specification Changes
  • Request Body
    • payoff_amount string
    • This field contains the computed current loan payoff amount at the time of inquiry for the customer’s account with the biller.
    • Reg. Exp.: (\+|\-)?([0-9]{1,14}(\.[0-9][0-9]?)?)
    • payoff_expiry_date string
    • The date till the payoff_amount is valid for the customer’s account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
    • Reg. Exp.: ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|1\d|2\d|3[01])$
    • address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}
  • Response Body
    • payoff_amount string
    • This field contains the computed current loan payoff amount at the time of inquiry for the customer’s account with the biller.
    • Reg. Exp.: (\+|\-)?([0-9]{1,14}(\.[0-9][0-9]?)?)
    • payoff_expiry_date string
    • The date till the payoff_amount is valid for the customer’s account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
    • Reg. Exp.: ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|1\d|2\d|3[01])$
    • address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}

Payment

Create Payment

Specification Changes
  • Request Body
    • payment_amount_type string
    • The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other.
    • Valid Values :    payoff_amount,  paydown_amount, current_balance, minimum_payment_due, past_payment_due, statement_balance, discounted_amount, penalty_amount, other
  • Response Body
    • payment_amount_type string
    • The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other.
    • Valid Values :    payoff_amount,  paydown_amount, current_balance, minimum_payment_due, past_payment_due, statement_balance, discounted_amount, penalty_amount, other
    • customer.address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}

Update Payment

Specification Changes
  • Request Body
    • payment_amount_type string
    • The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other.
    • Valid Values :    payoff_amount,  paydown_amount, current_balance, minimum_payment_due, past_payment_due, statement_balance, discounted_amount, penalty_amount, other
  • Response Body
    • payment_amount_type string
    • The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other.
    • Valid Values :    payoff_amount,  paydown_amount, current_balance, minimum_payment_due, past_payment_due, statement_balance, discounted_amount, penalty_amount, other
    • customer.address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}

Get Payment

Specification Changes
  • Response Body
    • payment_amount_type string
    • The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other.
    • Valid Values :    payoff_amount,  paydown_amount, current_balance, minimum_payment_due, past_payment_due, statement_balance, discounted_amount, penalty_amount, other
    • customer.address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}

Simple Payment

Specification Changes
  • Request Body
    • customer_account.payoff_amount string
    • This field contains the computed current loan payoff amount at the time of inquiry for the customer’s account with the biller.
    • Reg. Exp.: (\+|\-)?([0-9]{1,14}(\.[0-9][0-9]?)?)
    • customer_account.payoff_expiry_date string
    • The date till the payoff_amount is valid for the customer’s account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
    • Reg. Exp.: ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|1\d|2\d|3[01])$
    • payment_amount_type string required
    • The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment.
    • Valid Values :    payoff_amount,  paydown_amount, current_balance, minimum_payment_due, past_payment_due, statement_balance, discounted_amount, penalty_amount, other
    • customer.address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}
    • customer_account.address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}
  • Response Body
    • customer_account.payoff_amount string
    • This field contains the computed current loan payoff amount at the time of inquiry for the customer’s account with the biller.
    • Reg. Exp.: (\+|\-)?([0-9]{1,14}(\.[0-9][0-9]?)?)
    • customer_account.payoff_expiry_date string
    • The date till the payoff_amount is valid for the customer’s account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
    • Reg. Exp.: ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|1\d|2\d|3[01])$
    • payment_amount_type string
    • The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other.
    • Valid Values :    payoff_amount,  paydown_amount, current_balance, minimum_payment_due, past_payment_due, statement_balance, discounted_amount, penalty_amount, other
    • customer.address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}
    • customer_account.address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}

Retrieve Payments

Specification Changes
  • Response Body
    • list[n].payment_amount_type string
    • The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other.
    • Valid Values :    payoff_amount,  paydown_amount, current_balance, minimum_payment_due, past_payment_due, statement_balance, discounted_amount, penalty_amount, other
    • list[n].customer.address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}

Get Fee Payment

Specification Changes
  • Response Body
    • payment_amount_type string
    • The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other.
    • Valid Values :    payoff_amount,  paydown_amount, current_balance, minimum_payment_due, past_payment_due, statement_balance, discounted_amount, penalty_amount, other
    • customer.address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}

Record Payment

Specification Changes
  • Request Body
    • customer_account.payoff_amount string
    • This field contains the computed current loan payoff amount at the time of inquiry for the customer’s account with the biller.
    • Reg. Exp.: (\+|\-)?([0-9]{1,14}(\.[0-9][0-9]?)?)
    • customer_account.payoff_expiry_date string
    • The date till the payoff_amount is valid for the customer’s account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
    • Reg. Exp.: ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|1\d|2\d|3[01])$
    • payment_amount_type string
    • The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other.
    • Valid Values :    payoff_amount,  paydown_amount, current_balance, minimum_payment_due, past_payment_due, statement_balance, other
    • customer.address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}
    • customer_account.address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}
  • Response Body
    • customer_account.payoff_amount string
    • This field contains the computed current loan payoff amount at the time of inquiry for the customer’s account with the biller.
    • Reg. Exp.: (\+|\-)?([0-9]{1,14}(\.[0-9][0-9]?)?)
    • customer_account.payoff_expiry_date string
    • The date till the payoff_amount is valid for the customer’s account with the biller. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
    • Reg. Exp.: ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|1\d|2\d|3[01])$
    • payment_amount_type string
    • The type of amount, as per the bill/statement, that is being paid. The payment amount is derived from the amount type selected for the payment. This defaults to other.
    • Valid Values :    payoff_amount,  paydown_amount, current_balance, minimum_payment_due, past_payment_due, statement_balance, other
    • customer.address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}
    • customer_account.address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}

Payment Setup

Create Payment Setup

Specification Changes
  • Response Body
    • customer.address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}

Update Payment Setup

Specification Changes
  • Response Body
    • customer.address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}

Get Payment Setup

Specification Changes
  • Response Body
    • customer.address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}

Retrieve Payment Setups

Specification Changes
  • Response Body
    • list[n].customer.address.address_zip1 string
    • The first part of the postal code for the address as per the system followed in the appropriate country where it belongs.
    • Reg. Exp.: [0-9]{5} [a-zA-Z0-9 -]{2,10}