V1.4.0 Changelog

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

Payments API

  • Added Renew Customer Account API
    This API is used to renew a customer account. The API migrates all the pending payments and active payment setups from the original customer account to the new one.
  • Added Simple Payment API
    The API is used to make payments to service a customer account. Client systems can provide the unique identifier for the payment in their system as payment_reference. Fee amount and fee type are conditional and should be provided if the details of the fee to be charged are maintained in the client system. The fee types that are supported in Orbipay are add_to_principal and bill_separately. Alternatively, the fee information can be setup in Orbipay, in which case, these fields are ignored. If fee information is setup in the system, the details of the fee are returned in the response. This API updates the details of the customer, customer account and the funding account if those exist in Orbipay or creates them otherwise.
  • Added GET Refund API
    The API is used to retrieve the details of a refund by id.
  • Added Retrieve Refunds API
    The API is used to retrieve the refunds made to a customer against payments processed through Orbipay. Refunds can be filtered using the customer id, confirmation number of the payment being refunded or of the refund, status of the refund and others mentioned below. Scheduled refunds that are yet to be processed and all the refunds processed in the last six months are returned if date criteria is not specified. If the requestor_type is customer then the id_customer request parameter is mandatory.

Customer

Create Customer

Specification Changes
  • Request Body
    • customer_accounts[n].address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+
    • customer_accounts[n].account_number string required
    • The number or reference that a customer uses to identify the customer's account.
    • Min. Length: 1 Max. Length: 32 Reg. Exp.: [a-zA-Z0-9-_/!@#$%&*{}.]+ [a-zA-Z0-9-_/!@#$%&*{}. ']+
    • address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+
  • Response Body
    • customer_accounts.list[n].audit_info object
    • audit_info object
    • address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+
    • customer_accounts.list[n].address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+
    • customer_accounts.list[n].account_number string
    • The number or reference that a customer uses to identify the customer's account.
    • Min. Length: 1 Max. Length: 32 Reg. Exp.: [a-zA-Z0-9-_/!@#$%&*{}.]+ [a-zA-Z0-9-_/!@#$%&*{}. ']+

Get Customer

Specification Changes
  • Response Body
    • customer_accounts.list[n].audit_info object
    • audit_info object
    • address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+
    • customer_accounts.list[n].address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+
    • customer_accounts.list[n].account_number string
    • The number or reference that a customer uses to identify the customer's account.
    • Min. Length: 1 Max. Length: 32 Reg. Exp.: [a-zA-Z0-9-_/!@#$%&*{}.]+ [a-zA-Z0-9-_/!@#$%&*{}. ']+

Update Customer

Specification Changes
  • Request Body
    • customer_accounts[n].address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+
    • customer_accounts[n].account_number string required
    • The number or reference that a customer uses to identify the customer's account.
    • Min. Length: 1 Max. Length: 32 Reg. Exp.: [a-zA-Z0-9-_/!@#$%&*{}.]+ [a-zA-Z0-9-_/!@#$%&*{}. ']+
    • address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+
  • Response Body
    • customer_accounts.list[n].audit_info object
    • audit_info object
    • address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+
    • customer_accounts.list[n].address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+
    • customer_accounts.list[n].account_number string
    • The number or reference that a customer uses to identify the customer's account.
    • Min. Length: 1 Max. Length: 32 Reg. Exp.: [a-zA-Z0-9-_/!@#$%&*{}.]+ [a-zA-Z0-9-_/!@#$%&*{}. ']+

Retrieve Customers

Specification Changes
  • Form Params
    • account_number string
    • Customer Account Number of the customer to get details of.
    • Min. Length: 1 Max. Length: 32 Reg. Exp.: [a-zA-Z0-9-_/!@#$%&*{}.]+ [a-zA-Z0-9-_/!@#$%&*{}. ']+
  • Response Body
    • list[n].customer_accounts.list[n].audit_info object
    • list[n].audit_info object
    • list[n].address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+
    • list[n].customer_accounts.list[n].address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+
    • list[n].customer_accounts.list[n].account_number string
    • The number or reference that a customer uses to identify the customer's account.
    • Min. Length: 1 Max. Length: 32 Reg. Exp.: [a-zA-Z0-9-_/!@#$%&*{}.]+ [a-zA-Z0-9-_/!@#$%&*{}. ']+

Customer Account

Retrieve Customer Accounts

Specification Changes
  • Form Params
    • account_number string
    • The Account Number to get details of.
    • Min. Length: 1 Max. Length: 32 Reg. Exp.: [a-zA-Z0-9-_/!@#$%&*{}.]+ [a-zA-Z0-9-_/!@#$%&*{}. ']+
  • Response Body
    • list[n].audit_info object
    • list[n].address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+
    • list[n].account_number string
    • The number or reference that a customer uses to identify the customer's account.
    • Min. Length: 1 Max. Length: 32 Reg. Exp.: [a-zA-Z0-9-_/!@#$%&*{}.]+ [a-zA-Z0-9-_/!@#$%&*{}. ']+

Get Customer Account

Specification Changes
  • Response Body
    • audit_info object
    • address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+
    • account_number string
    • The number or reference that a customer uses to identify the customer's account.
    • Min. Length: 1 Max. Length: 32 Reg. Exp.: [a-zA-Z0-9-_/!@#$%&*{}.]+ [a-zA-Z0-9-_/!@#$%&*{}. ']+

Funding Account

Add Funding Account

Specification Changes
  • Request Body
    • address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+
  • Response Body
    • audit_info object
    • address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+

Retrieve Funding Accounts

Specification Changes
  • Response Body
    • list[n].audit_info object
    • list[n].address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+

Get Funding Account

Specification Changes
  • Response Body
    • audit_info object
    • address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+

Update Funding Account

Specification Changes
  • Request Body
    • address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+
  • Response Body
    • audit_info object
    • address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+

Replace Funding Account

Specification Changes
  • Request Body
    • address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+
  • Response Body
    • audit_info object
    • address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+

Payment

Retrieve Payments

Specification Changes
  • Response Body
    • list[n].payment_network_response object
    • The response received from either the ACH or Card network.
    • list[n].audit_info object
    • list[n].customer.address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+

Create Payment

Specification Changes
  • Response Body
    • payment_network_response object
    • The response received from either the ACH or Card network.
    • audit_info object
    • customer.address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+

Get Payment

Specification Changes
  • Response Body
    • payment_network_response object
    • The response received from either the ACH or Card network.
    • audit_info object
    • customer.address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+

Update Payment

Specification Changes
  • Response Body
    • payment_network_response object
    • The response received from either the ACH or Card network.
    • audit_info object
    • customer.address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+

Payment Setup

Retrieve Payment Setups

Specification Changes
  • Response Body
    • list[n].payment_network_response object
    • The response received from either the ACH or Card network.
    • list[n].audit_info object
    • list[n].customer.address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+

Create Payment Setup

Specification Changes
  • Response Body
    • payment_network_response object
    • The response received from either the ACH or Card network.
    • audit_info object
    • customer.address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+

Get Payment Setup

Specification Changes
  • Response Body
    • payment_network_response object
    • The response received from either the ACH or Card network.
    • audit_info object
    • customer.address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+

Update Payment Setup

Specification Changes
  • Response Body
    • payment_network_response object
    • The response received from either the ACH or Card network.
    • audit_info object
    • customer.address.address_city string
    • Max. Length: 20 50 Reg. Exp.: [0-9a-zA-Z ,.-]+

Refund

Create Refund

Specification Changes
  • Request Body
    • fee_refund object
    • refund_type string required
    • The portion of the payment amount that is to be or has been refunded. The original payment can be refunded fully including the amount and the fee components, or partially, for just the amount or the fee component. Refund can also be initiated for an arbitrary amount limited by the original payment amount.
    • Valid Values: payment_and_fee, payment_only, fee_only, other
  • Response Body
    • refund_date string
    • The date on which the refund is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
    • Min. Length: 10 Max. Length: 10
    • refund_entry_date string
    • The date on which the refund captured in Orbipay. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.
    • Min. Length: 10 Max. Length: 10
    • source_payment.customer object
    • source_payment.customer_account object
    • source_payment.funding_account object
    • The customer's funding account with which the payment is being made.
    • payment_network_response object
    • The response received from either the ACH or Card network.
    • audit_info object
    • status string
    • The status of the refund.
    • Valid Values: scheduled, processing, processed, declined scheduled, cancelled, processing, processed, declined, returned