V1.5.0 Changelog

  Added   Modified (Older values highlighted with strike through)   Deprecated   Removed

Request Headers

  • requestor_type string required
  • If an API is being requested from an application that is being used directly by a customer, like the customer portal and IVR, the requestor_type should be set to "customer". It should be noted that there should be a user in the EBPP Portal (or Payment Center) corresponding to this user.
    If an API is being requested from an application that is being used by third party agents/brokers servicing a customer on behalf of a biller/client, then the requestor_type should be set to "external_user". It should be noted that these users would not have logins for the Orbipay EBPP Portal or Payment Center.
  • Valid Values: customer, client_agent, external_user customer, external_user

Response Headers

  • requestor_type string
  • If an API is being requested from an application that is being used directly by a customer, like the customer portal and IVR, the requestor_type should be set to "customer". It should be noted that there should be a user in the EBPP Portal (or Payment Center) corresponding to this user.
    If an API is being requested from an application that is being used by third party agents/brokers servicing a customer on behalf of a biller/client, then the requestor_type should be set to "external_user". It should be noted that these users would not have logins for the Orbipay EBPP Portal or Payment Center.
  • Valid Values: customer, client_agent, external_user customer, external_user

Payments API

Customer

Create Customer

Specification Changes
  • Request Body
    • customer_accounts[n].address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$
    • address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$
  • Response Body
    • address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$
    • customer_accounts.list[n].address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$

Get Customer

Specification Changes
  • Response Body
    • address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$
    • customer_accounts.list[n].address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$

Update Customer

Specification Changes
  • Request Body
    • address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$
    • customer_accounts[n].address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$
  • Response Body
    • address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$
    • customer_accounts.list[n].address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$

Retrieve Customers

Specification Changes
  • Response Body
    • query_id string
    • The query id of the object.
    • Max. Length: 50 Reg. Exp.: [a-zA-Z0-9]{0,50}
    • list[n].address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$
    • list[n].customer_accounts.list[n].address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$

Customer Account

Retrieve Customer Accounts

Specification Changes
  • Response Body
    • query_id string
    • The query id of the object.
    • Max. Length: 50 Reg. Exp.: [a-zA-Z0-9]{0,50}
    • list[n].address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$

Get Customer Account

Specification Changes
  • Response Body
    • address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$

Renew Customer Account

Specification Changes
  • Request Body
    • address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$
  • Response Body
    • address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$

Funding Account

Add Funding Account

Specification Changes
  • Request Body
    • address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$
  • Response Body
    • address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$

Retrieve Funding Accounts

Specification Changes
  • Response Body
    • query_id string
    • The query id of the object.
    • Max. Length: 50 Reg. Exp.: [a-zA-Z0-9]{0,50}
    • list[n].address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$

Get Funding Account

Specification Changes
  • Response Body
    • address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$

Update Funding Account

Specification Changes
  • Request Body
    • address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$
  • Response Body
    • address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$

Replace Funding Account

Specification Changes
  • Request Body
    • address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$
  • Response Body
    • address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$

Payment

Retrieve Payments

Specification Changes
  • Response Body
    • list[n].funding_account.issuer_name string
    • The name of the authority that has issued the account. This is relevant only in the case of bank accounts.
    • Max. Length: 32 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+
    • query_id string
    • The query id of the object.
    • Max. Length: 50 Reg. Exp.: [a-zA-Z0-9]{0,50}
    • list[n].customer.address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$

Simple Payment

Specification Changes
  • Request Body
    • customer.address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$
    • funding_account.address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$
    • customer_account.address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$
  • Response Body
    • customer.address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$
    • funding_account.address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$
    • customer_account.address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$

Create Payment

Specification Changes
  • Response Body
    • funding_account.issuer_name string
    • The name of the authority that has issued the account. This is relevant only in the case of bank accounts.
    • Max. Length: 32 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+
    • customer.address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$

Get Payment

Specification Changes
  • Response Body
    • funding_account.issuer_name string
    • The name of the authority that has issued the account. This is relevant only in the case of bank accounts.
    • Max. Length: 32 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+
    • customer.address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$

Update Payment

Specification Changes
  • Response Body
    • funding_account.issuer_name string
    • The name of the authority that has issued the account. This is relevant only in the case of bank accounts.
    • Max. Length: 32 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+
    • customer.address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$

Payment Setup

Retrieve Payment Setups

Specification Changes
  • Response Body
    • list[n].funding_account.issuer_name string
    • The name of the authority that has issued the account. This is relevant only in the case of bank accounts.
    • Max. Length: 32 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+
    • query_id string
    • The query id of the object.
    • Max. Length: 50 Reg. Exp.: [a-zA-Z0-9]{0,50}
    • list[n].customer.address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$

Create Payment Setup

Specification Changes
  • Response Body
    • funding_account.issuer_name string
    • The name of the authority that has issued the account. This is relevant only in the case of bank accounts.
    • Max. Length: 32 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+
    • customer.address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$

Get Payment Setup

Specification Changes
  • Response Body
    • funding_account.issuer_name string
    • The name of the authority that has issued the account. This is relevant only in the case of bank accounts.
    • Max. Length: 32 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+
    • customer.address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$

Update Payment Setup

Specification Changes
  • Response Body
    • funding_account.issuer_name string
    • The name of the authority that has issued the account. This is relevant only in the case of bank accounts.
    • Max. Length: 32 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+
    • customer.address.address_city string
    • Max. Length: 50 Reg. Exp.: [0-9a-zA-Z ,.-]+ ^[0-9a-zA-Z ,.-]+(?:'[0-9a-zA-Z ,.-]+)*$

Refund

Create Refund

Specification Changes
  • Response Body
    • source_payment.funding_account.issuer_name string
    • The name of the authority that has issued the account. This is relevant only in the case of bank accounts.
    • Max. Length: 32 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+

Get Refund

Specification Changes
  • Response Body
    • source_payment.funding_account.issuer_name string
    • The name of the authority that has issued the account. This is relevant only in the case of bank accounts.
    • Max. Length: 32 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+

Retrieve Refunds

Specification Changes
  • Response Body
    • list[n].source_payment.funding_account.issuer_name string
    • The name of the authority that has issued the account. This is relevant only in the case of bank accounts.
    • Max. Length: 32 Reg. Exp.: [0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\\"]+
    • query_id string
    • The query id of the object.
    • Max. Length: 50 Reg. Exp.: [a-zA-Z0-9]{0,50}