V1.3.0 Changelog

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

Payments API

  • Added Update Payment Setup API
    This API is used to edit a payment Setup. Only the autopay payment setup can be edited.
  • Added Replace Funding Account API
    This API is used to replace one funding account with another one. The API migrates all the pending payments and active payment setups from the replaced funding account to the new one. Both the replaced and the new funding account have to be of the same type. For e.g., a DDA account can be replaced with only another DDA account. The subtype of the two funding accounts need not be the same.

Customer

Create Customer

Specification Changes
  • Request Body
    • registered_email string
    • The email address of the customer registered with the client. This may be used to uniquely identify the customer if the client is set up accordingly in Orbipay.
    • Max. Length: 100 Reg. Exp.: [a-zA-Z0-9!#$%&'*+-/=?^._`{|}~]+@[a-zA-Z0-9_.-]+\.[a-zA-Z0-9._]+
  • Response Body
    • registered_email string
    • The email address of the customer registered with the client. This may be used to uniquely identify the customer if the client is set up accordingly in Orbipay.
    • Max. Length: 100 Reg. Exp.: [a-zA-Z0-9!#$%&'*+-/=?^._`{|}~]+@[a-zA-Z0-9_.-]+\.[a-zA-Z0-9._]+

Get Customer

Specification Changes
  • Response Body
    • registered_email string
    • The email address of the customer registered with the client. This may be used to uniquely identify the customer if the client is set up accordingly in Orbipay.
    • Max. Length: 100 Reg. Exp.: [a-zA-Z0-9!#$%&'*+-/=?^._`{|}~]+@[a-zA-Z0-9_.-]+\.[a-zA-Z0-9._]+

Update Customer

Specification Changes
  • Request Body
    • registered_email string
    • The email address of the customer registered with the client. This may be used to uniquely identify the customer if the client is set up accordingly in Orbipay.
    • Max. Length: 100 Reg. Exp.: [a-zA-Z0-9!#$%&'*+-/=?^._`{|}~]+@[a-zA-Z0-9_.-]+\.[a-zA-Z0-9._]+
  • Response Body
    • registered_email string
    • The email address of the customer registered with the client. This may be used to uniquely identify the customer if the client is set up accordingly in Orbipay.
    • Max. Length: 100 Reg. Exp.: [a-zA-Z0-9!#$%&'*+-/=?^._`{|}~]+@[a-zA-Z0-9_.-]+\.[a-zA-Z0-9._]+

Retrieve Customers

Specification Changes
  • Response Body
    • list[n].registered_email string
    • The email address of the customer registered with the client. This may be used to uniquely identify the customer if the client is set up accordingly in Orbipay.
    • Max. Length: 100 Reg. Exp.: [a-zA-Z0-9!#$%&'*+-/=?^._`{|}~]+@[a-zA-Z0-9_.-]+\.[a-zA-Z0-9._]+

Payment

Retrieve Payments

Specification Changes
  • Response Body
    • list[n].customer.customer_reference string
    • The unique identifier in the client system for the customer.
    • Max. Length: 100 Reg. Exp.: ^$|[0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\s\\"]+

Create Payment

Specification Changes
  • Response Body
    • customer.customer_reference string
    • The unique identifier in the client system for the customer.
    • Max. Length: 100 Reg. Exp.: ^$|[0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\s\\"]+

Get Payment

Specification Changes
  • Response Body
    • customer.customer_reference string
    • The unique identifier in the client system for the customer.
    • Max. Length: 100 Reg. Exp.: ^$|[0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\s\\"]+

Update Payment

Specification Changes
  • Response Body
    • customer.customer_reference string
    • The unique identifier in the client system for the customer.
    • Max. Length: 100 Reg. Exp.: ^$|[0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\s\\"]+

Payment Setup

Retrieve Payment Setups

Specification Changes
  • Response Body
    • list[n].customer.customer_reference string
    • The unique identifier in the client system for the customer.
    • Max. Length: 100 Reg. Exp.: ^$|[0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\s\\"]+

Create Payment Setup

Specification Changes
  • Response Body
    • customer.customer_reference string
    • The unique identifier in the client system for the customer.
    • Max. Length: 100 Reg. Exp.: ^$|[0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\s\\"]+

Get Payment Setup

Specification Changes
  • Response Body
    • customer.customer_reference string
    • The unique identifier in the client system for the customer.
    • Max. Length: 100 Reg. Exp.: ^$|[0-9a-zA-Z #,.'&/\-@!$%*()_+={}|:;`\[\]\^\~\s\\"]+