Unified Money Movement Services for Financial Institutions (1.0)

Contact/customers: support@billerpayments.com License: © Alacriti Inc

Introduction

Unified Money Movement Services offers connectivity to various payment rails like TCH RTP, Visa Direct, NACHA and Fedwire. It includes a set of API and Webhooks that can be used to deliver payment and related capabilities.

This document details the various API involved in the Unified Money Movement Services and how they can be used.

Authentication

Overview

The requests are authenticated using the api_key which is shared with the client at the time of client on-boarding. The client can only invoke those APIs based on the permissions assigned to the api_key

OPAY1-HMAC-SHA256

The HTTP Authorization request header is used to provide authentication information. This header looks like the following.

Authorization : OPAY1-HMAC-SHA256 Credential=...,Signature=...

The constituents of the authorization header are explained in the table below.

Item Description
OPAY1-HMAC-SHA256 The algorithm that is used to calculate the signature.
Credential The API key
Signature The Base 64 encoded value of the signature bytes. Calculating the signature bytes is explained below.

Signature Calculation

Signature is calculated as follows.

Base64(HMAC-SHA256(secret,input))

The calculation is explained in detail below.

Item Description
Base64() The encoding of the signature bytes.
HMAC-SHA256() The cryptographic function that computes the HMAC by using the SHA256 algorithm with the client secret provided.
secret The secret key specific to the client that is shared with the client during onboarding.
input The string value of the canonicalized transform of request data that includes the HTTP method, URL, headers, query parameters and body. The details of computing the input is explained below.

The string input is computed as follows.

input = method():path():queryString():headers():payload()

Each of the substrings is explained below.

Item Description
method() The HTTP method for the given request and evaluates to one of GET, PUT, POST or DELETE.
path() The absolute path component of the URI—everything starting with the "/" that follows the domain name and up to the end of the string or to the question mark character ("?") if the given URL has query string parameters.
queryString() A string in the format param1=value1&param2=value2&…, where the query parameters are sorted in alphabetical order of the parameter names. In case multiple values are present for a parameter, the query parameters are sorted in alphabetical order of the parameter names and subsequently by the parameter values for each such paramter. Both the parameter names and their values should be trimmed for leading and trailing whitespaces, should be in their normal pre-encoded format. Only parameters with non-empty values, after trimming the leading and trailing whitespaces, should be included. If there are no query parameters at all, the queryString() should evaluate to an empty string (“”).
headers() A string in the format header1=value1&header2=value2&.......&headerN=valueN. The headers are to be sorted alphabetically. Both the header names and their values must be trimmed for leading and trailing white-space, and in their normal pre-encoded format . Only the headers listed by the application and those that are non-empty, after trimming the leading and trailing whitespaces, are to be included.
payload() The raw HTTP body

Error Handling

HTTP Response Codes

The Unified Money Movement Services API uses the standard HTTP response codes to return the status of an API call. An HTTP response code of 2xx indicates success. An HTTP response code of 4xx indicates a client error and 5xx indicates a processing error. In these cases, the API returns a list of errors.

Error Codes

Each error in the list has a code, message, and specifics on which field the error pertains to (if applicable). In addition to these details, it can also have a list of inner errors that caused this error, on the lines of an Exception Stack trace.

Below table specifies the Error category and Error code.

Error Category Code
Validation Error MM-10-XXXXXX.
Business Error MM-20-XXXXXX.
System Error MM-50-XXXXXX. 
          // format
      {
         "error": [
             {
                 "code": "MM-10-XXXXXX",
                 "message": "Error message"
             }
         ]
     }

UMM Codes Sets

Various codes sets used by the API and Webhooks can be found here

Duplicate Requests and Retries

The Unified Money Movement Services API supports idempotency for the HTTP methods POST, PUT, DELETE and PATCH using the header parameter, namely, idempotent_request_key. In other words, any POST, PUT, DELETE and PATCH request will be considered as a duplicate request or retry and not reprocessed by the API if all the request parameters, including the path and query parameters, the request headers and the request body, match with an earlier request. In case of duplicate requests or retries, the API response will be that of the original request. The idempotent_request_key is valid only for a day from the time of the original request. Any duplicate request or retries after a day from the original request will be considered as a fresh request.

Hypermedia

As per REST guidelines, Unified Money Movement Services API supports hypermedia. This allows for simple and intuitive navigation between the resources, making it easy to fetch associated metadata for any given resource.

Pagination

The various Retrieve methods listed below, like Retrieve Payments and Retrieve Linked Accounts return a list of results matching the specified filter criteria. However, all the items in the list are not returned at once, but instead are returned in groups called pages. The size of the page can be set by the caller using the request parameter called page_size. The default page size is 10.

Each page of results consists of a list of items, the url to fetch any page in the list along with the current page number.To fetch any page in the list, the appropriate query string has to be appended to the url. This can be done as follows.

<url>&page_number=<page number>

Transfer

Create Simple Transfer

Create Simple Transfer API is used to transfer funds from a customer's bank account to another bank account or debit card without explicitly adding a beneficiary or beneficiary account. This is useful when the customer wants to make a one-off payment to an account.

query Parameters
name_match
string

Indicates card account name match strategy to be followed.

Possible Values :
strict complete name match only.
lenient complete or partial name match, name match not supported for card.
ignore name match not required. default

approval
string

Indicates if approval is required or not before processing the transaction.

Possible Values :
required Approval is required.
not_required Approval is not required. default

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:business_transfers

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party, client_agent, external_agent

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

processing_mode
string

Indicates whether the transaction will be processed synchronously or asynchronously, in a non-blocking fashion.

Possible Values :
synchronous The transaction will be processed in a blocking fashion. default
asynchronous The transaction will be processed in a non-blocking fashion.

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
source
required
object

The JSON that contains all the attributes of source or the customer initaiting the payment.

source_account
required
bank_account (object) or card_account (object)

Indicates source account

original_source
object

The name of the actual payer or the ultimate debtor.

destination
object

The recipient of funds .

ultimate_destination
object

The actual recipient of funds or the ultimate creditor. This could be different from the entity whose account is being credited.

destination_account
required
bank_account (object) or card_account (object) or xb_bank_account (object)

Indicates the recipient account of the payment.

intermediary_agent
Array of objects

Intermediary Agent

amount
required
object

The amount being transfered from the source account to the destination account.

fee
object

The fee being charged for the transfer being made.

payment_reference
required
string [ 1 .. 36 ] characters [0-9a-zA-Z_-]{1,36}

The unique identifier that the bank might want to assign for the payment.

end_to_end_reference
required
string [ 1 .. 35 ] characters

The reference for the payment that is passed on from the initiator to the recipient. This is the reference that traces the entire flow of the payment. However, please note that certain payment rails do not support an end to end reference.The maximum length for the end_to_end_reference varies across different payment rails and is outlined below

Payment Method Max Length Sent to Network
RTP 35 Yes
FEDNOW 35 Yes
FEDWIRE 35 Yes
ACH 15 Yes
CARD_VISA 16 No

uetr
string [ 1 .. 36 ] characters [a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}

The Universally unique identifier that the bank might want to assign a unique end-to-end reference of a payment transaction.

fulfilment_type
string
Enum: "instant" "regular" "instant.BOOK_TRANSFER" "instant.TCH_RTP" "instant.FEDNOW" "instant.CARD_VISA" "urgent.SAMEDAY_ACH" "urgent.FEDWIRE" "regular.ACH"
payment_date
string 10 characters YYYY-MM-DD
businessfunction_entryclass
VISA (string) or NACHA (string)

The payment network specific code corresponding to the business application or function for the transaction. This corresponds to the Business Application Identifier (BAI) in the case of Visa transactions, the Standard Entry Class (SEC) code in the case of ACH transactions and so on.

purpose
object

Underlying reason for the payment transaction. Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.

payment_category
object

Specifies the high level purpose of the instruction based on a set of pre-defined categories. This is used by the initiating party to provide information concerning the processing of the payment. It is likely to trigger special processing by any of the agents involved in the payment chain.

Constraints: CMM16
instruction_for_fi
Array of objects
remittance_info
object

Information supplied to enable the matching/reconciliation of an entry with the item(s) that the payout is intended to settle, such as bills or RFPs received.

related_remittance_info
object
approval_info
Array of objects

Information about who has created and approved the payment.

Responses

201

The Payment object with id and confirmation mumber issued by Unified Money Movement Services.

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

Error Codes

The following table lists the business errors that need to be handled by the client.
click here

Events

Following events are triggered in the context of this API
moneymovementservices.payment.status_updated
moneymovementservices.payment.payment_originated
moneymovementservices.payment.payment_updated
moneymovementservices.payment.return_received
post/transfer/simpletransfer
https://api.orbipay.com/umm/v1/transfer/simpletransfer

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Update Transfer

The Update Transfer API is used to modify details of an existing fund transfer initiated through the Simple Transfer API. This allows customers to make adjustments to a previously created transfer, such as changing the transfer amount, schedule date, or recipient details, before the transfer is executed. The Edit Transfer API is particularly useful for correcting errors or updating information for a one-off payment without the need to reinitiate the transfer.

query Parameters
name_match
string

Indicates card account name match strategy to be followed.

Possible Values :
strict complete name match only.
lenient complete or partial name match, name match not supported for card.
ignore name match not required. default

approval
string

Indicates if approval is required or not before processing the transaction.

Possible Values :
required Approval is required.
not_required Approval is not required. default

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:business_transfers

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party, client_agent, external_agent

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

processing_mode
string

Indicates whether the transaction will be processed synchronously or asynchronously, in a non-blocking fashion.

Possible Values :
synchronous The transaction will be processed in a blocking fashion. default
asynchronous The transaction will be processed in a non-blocking fashion.

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
payment_reference
string [ 1 .. 36 ] characters [0-9a-zA-Z_-]{1,36}

The unique identifier that the bank had assigned when the payment was initially created.This identifier is required to locate the existing payment record and make the necessary edits.

Constraints: CMM11
id
string [ 0 .. 20 ] characters [0-9]{1,20}

The unique identifier assigned by Unified Money Movement Services to payment was originally created.

Constraints: CMM11
original_source
object

The name of the actual payer or the ultimate debtor.

destination
object

The recipient of funds .

ultimate_destination
object

The actual recipient of funds or the ultimate creditor. This could be different from the entity whose account is being credited.

destination_account
required
bank_account (object) or card_account (object) or xb_bank_account (object)

Indicates the recipient account of the payment.

intermediary_agent
Array of objects

Intermediary Agent

amount
required
object

The amount being transfered from the source account to the destination account.

fee
object

The fee being charged for the transfer being made.

payment_date
string 10 characters YYYY-MM-DD
businessfunction_entryclass
VISA (string) or NACHA (string)

The payment network specific code corresponding to the business application or function for the transaction. This corresponds to the Business Application Identifier (BAI) in the case of Visa transactions, the Standard Entry Class (SEC) code in the case of ACH transactions and so on.

purpose
object

Underlying reason for the payment transaction. Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.

payment_category
object

Specifies the high level purpose of the instruction based on a set of pre-defined categories. This is used by the initiating party to provide information concerning the processing of the payment. It is likely to trigger special processing by any of the agents involved in the payment chain.

Constraints: CMM16
instruction_for_fi
Array of objects
remittance_info
object

Information supplied to enable the matching/reconciliation of an entry with the item(s) that the payout is intended to settle, such as bills or RFPs received.

related_remittance_info
object
approval_info
Array of objects

Information about who has created and approved the payment.

Responses

200

The Payment object with id and confirmation mumber issued by Unified Money Movement Services.

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

Error Codes

The following table lists the business errors that need to be handled by the client.
click here

Events

Following events are triggered in the context of this API
moneymovementservices.payment.payment_updated
post/transfer/updatetransfer
https://api.orbipay.com/umm/v1/transfer/updatetransfer

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Prepare Transfer

Prepare Transfer API is used to validate and review transfer requests before initiating the actual fund transfer request from a customer's bank account to another bank account or debit card without explicitly adding a beneficiary or beneficiary account. This is useful when the customer wants to make a one-off payment to an account.

query Parameters
name_match
string

Indicates card account name match strategy to be followed.

Possible Values :
strict complete name match only.
lenient complete or partial name match, name match not supported for card.
ignore name match not required. default

approval
string

Indicates if approval is required or not before processing the transaction.

Possible Values :
required Approval is required.
not_required Approval is not required. default

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:business_transfers

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party, client_agent, external_agent

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

processing_mode
string

Indicates whether the transaction will be processed synchronously or asynchronously, in a non-blocking fashion.

Possible Values :
synchronous The transaction will be processed in a blocking fashion. default
asynchronous The transaction will be processed in a non-blocking fashion.

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
source
required
object

The JSON that contains all the attributes of source or the customer initaiting the payment.

source_account
required
bank_account (object) or card_account (object)

Indicates source account

original_source
object

The name of the actual payer or the ultimate debtor.

destination
object

The recipient of funds .

ultimate_destination
object

The actual recipient of funds or the ultimate creditor. This could be different from the entity whose account is being credited.

destination_account
required
bank_account (object) or card_account (object)

Indicates the recipient account of the payment.

intermediary_agent
Array of objects

Intermediary Agent

amount
required
object

The amount being transfered from the source account to the destination account.

payment_reference
required
string [ 1 .. 36 ] characters [0-9a-zA-Z_-]{1,36}

The unique identifier that the bank might want to assign for the payment.

end_to_end_reference
required
string [ 1 .. 35 ] characters

The reference for the payment that is passed on from the initiator to the recipient. This is the reference that traces the entire flow of the payment. However, please note that certain payment rails do not support an end to end reference.The maximum length for the end_to_end_reference varies across different payment rails and is outlined below

Payment Method Max Length Sent to Network
RTP 35 Yes
FEDNOW 35 Yes
FEDWIRE 35 Yes
ACH 15 Yes
CARD_VISA 16 No

fulfilment_type
string
Enum: "instant" "regular" "instant.BOOK_TRANSFER" "instant.TCH_RTP" "instant.FEDNOW" "instant.CARD_VISA" "urgent.SAMEDAY_ACH" "urgent.FEDWIRE" "regular.ACH"
payment_date
string 10 characters YYYY-MM-DD
businessfunction_entryclass
VISA (string) or NACHA (string)

The payment network specific code corresponding to the business application or function for the transaction. This corresponds to the Business Application Identifier (BAI) in the case of Visa transactions, the Standard Entry Class (SEC) code in the case of ACH transactions and so on.

purpose
object

Underlying reason for the payment transaction. Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.

instruction_for_fi
Array of objects
remittance_info
object

Information supplied to enable the matching/reconciliation of an entry with the item(s) that the payout is intended to settle, such as bills or RFPs received.

related_remittance_info
object

Responses

200

The Payment object with id and confirmation mumber issued by Unified Money Movement Services.

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

Error Codes

The following table lists the business errors that need to be handled by the client.
click here

Events

Following events are triggered in the context of this API
moneymovementservices.payment.status_updated
post/transfer/preparetransfer
https://api.orbipay.com/umm/v1/transfer/preparetransfer

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Recurring Transfer

Create Recurring Transfer

query Parameters
name_match
string

Indicates card account name match strategy to be followed.

Possible Values :
strict complete name match only.
lenient complete or partial name match, name match not supported for card.
ignore name match not required. default

approval
string

Indicates if approval is required or not before processing the transaction.

Possible Values :
required Approval is required.
not_required Approval is not required. default

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:business_transfers

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party, client_agent, external_agent

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

processing_mode
string

Indicates whether the transaction will be processed synchronously or asynchronously, in a non-blocking fashion.

Possible Values :
synchronous The transaction will be processed in a blocking fashion. default
asynchronous The transaction will be processed in a non-blocking fashion.

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
source
required
object

The JSON that contains all the attributes of source or the customer initaiting the payment.

source_account
required
bank_account (object) or card_account (object)

Indicates source account

original_source
object

The name of the actual payer or the ultimate debtor.

destination
object

The recipient of funds .

ultimate_destination
object

The actual recipient of funds or the ultimate creditor. This could be different from the entity whose account is being credited.

destination_account
required
bank_account (object) or card_account (object)

Indicates the recipient account of the payment.

intermediary_agent
Array of objects

Intermediary Agent

amount
required
object

The amount being transfered from the source account to the destination account.

fee
object

The fee being charged for the transfer being made.

payment_setup_reference
required
string [ 1 .. 36 ] characters [0-9a-zA-Z_-]{1,36}

The unique identifier that the bank might want to assign for the payment.

end_to_end_reference
required
string [ 1 .. 35 ] characters

The reference for the payment that is passed on from the initiator to the recipient. This is the reference that traces the entire flow of the payment. However, please note that certain payment rails do not support an end to end reference.The maximum length for the end_to_end_reference varies across different payment rails and is outlined below

Payment Method Max Length Sent to Network
RTP 35 Yes
FEDNOW 35 Yes
FEDWIRE 35 Yes
ACH 15 Yes
CARD_VISA 16 No

fulfilment_type
string
Enum: "urgent.ACH" "urgent.FEDWIRE" "regular.ACH"
businessfunction_entryclass
VISA (string) or NACHA (string)

The payment network specific code corresponding to the business application or function for the transaction. This corresponds to the Business Application Identifier (BAI) in the case of Visa transactions, the Standard Entry Class (SEC) code in the case of ACH transactions and so on.

purpose
object

Underlying reason for the payment transaction. Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.

instruction_for_fi
Array of objects
remittance_info
object

Information supplied to enable the matching/reconciliation of an entry with the item(s) that the payout is intended to settle, such as bills or RFPs received.

related_remittance_info
object
frequency
required
string
Enum: "daily" "weekly" "biweekly" "monthly" "quaterly" "yearly"
number_of_occurrences
string [0-9]{1,20}

It specifies the number of payments to be done.

Constraints: CMM15
start_date
required
string ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|1\d|2\d|3[01])$

The date on which the first payment will be drafted as part of a recurring payment setup. This is to be specified in the ISO8601 full-date format, namely, YYYY-MM-DD.

end_date
string ^[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|1\d|2\d|3[01])$

The date by which the last payment will be drafted as part of a recurring payment setup. This is to be specified in the ISO8601 full-date format, namely, YYYY-MM-DD.

Constraints: CMM15
approval_info
Array of objects

Information about who has created and approved the payment.

Responses

201

The Payment object with id and confirmation mumber issued by Unified Money Movement Services.

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

Events

Following events are triggered in the context of this API
moneymovementservices.recurringpayment.payment_scheduled
post/transfer/recurringtransfer
https://api.orbipay.com/umm/v1/transfer/recurringtransfer

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Get Recurring Transfer

header Parameters
product
required
string

The product identifier corresponding to the API.
Possible values:business_transfers

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party, client_agent, external_agent

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

processing_mode
string

Indicates whether the transaction will be processed synchronously or asynchronously, in a non-blocking fashion.

Possible Values :
synchronous The transaction will be processed in a blocking fashion. default
asynchronous The transaction will be processed in a non-blocking fashion.

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
payment_setup_reference
string [ 1 .. 36 ] characters [0-9a-zA-Z_-]{1,36}

The unique identifier that the bank might want to assign for the payment.

Constraints: CMM11
id
string

The unique identifier assigned by Unified Money Movement Services to payment.

Constraints: CMM11

Responses

200

The Payment object with id and confirmation mumber issued by Unified Money Movement Services.

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

post/transfer/getrecurringtransfer
https://api.orbipay.com/umm/v1/transfer/getrecurringtransfer

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Get Recurring Transfer Instances

header Parameters
product
required
string

The product identifier corresponding to the API.
Possible values:business_transfers

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party, client_agent, external_agent

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

processing_mode
string

Indicates whether the transaction will be processed synchronously or asynchronously, in a non-blocking fashion.

Possible Values :
synchronous The transaction will be processed in a blocking fashion. default
asynchronous The transaction will be processed in a non-blocking fashion.

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
payment_setup_reference
string [ 1 .. 36 ] characters [0-9a-zA-Z_-]{1,36}

The unique identifier that the bank might want to assign for the payment.

Constraints: CMM11
id
string

The unique identifier assigned by Unified Money Movement Services to payment.

Constraints: CMM11
from_date
string

The instances generated after the date provided.

to_date
string

The instances generated before the date provided..

Responses

200

The Payment object with id and confirmation mumber issued by Unified Money Movement Services.

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

post/transfer/getrecurringinstances
https://api.orbipay.com/umm/v1/transfer/getrecurringinstances

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Delete Recurring Transfer

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:business_transfers

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party, client_agent, external_agent

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

processing_mode
string

Indicates whether the transaction will be processed synchronously or asynchronously, in a non-blocking fashion.

Possible Values :
synchronous The transaction will be processed in a blocking fashion. default
asynchronous The transaction will be processed in a non-blocking fashion.

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
payment_reference
string [ 1 .. 36 ] characters [0-9a-zA-Z_-]{1,36}

The unique identifier that the bank might want to assign for the recurring payment setup.

Constraints: CMM11
id
string

The unique identifier assigned by Unified Money Movement Services to recurring payment setup.

Constraints: CMM11
memo
string [ 1 .. 200 ] characters

The memo to delete the recurring payment setup.

Responses

200

The Payment object with id and confirmation mumber issued by Unified Money Movement Services.

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

post/transfer/deleterecurringtransfer
https://api.orbipay.com/umm/v1/transfer/deleterecurringtransfer

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

ACH Mass Payment

Inquire Batch Payment

Create Batch Payment API is used to make multiple payments in a batch mode. A batch can contain a list of either transfers or payouts. All payments in the batch should have the same payment date. If its batch is a payout batch, all the payments should have the same source.

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:business_transfers

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party, client_agent, external_agent

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

processing_mode
string

Indicates whether the transaction will be processed synchronously or asynchronously, in a non-blocking fashion.

Possible Values :
synchronous The transaction will be processed in a blocking fashion. default
asynchronous The transaction will be processed in a non-blocking fashion.

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
batch_reference
required
string [ 1 .. 50 ] characters

The unique identifier that the bank might want to assign for the batch.

file_reference
string [ 1 .. 50 ] characters

The file reference for the batch.

total_txn_count
string [ 1 .. 50 ] characters

Total transaction count in the batch.

total_txn_amount
string [ 1 .. 50 ] characters

Total transaction amount in the batch.

requested_execution_date
string

Requested Execution date.

fulfilment_type
string
Enum: "regular.ACH" "urgent.SAMEDAY_ACH"


regular.ACH - Typically 1-2 business days for processing. default
urgent.SAMEDAY_ACH - Typically same day processing.

payment_category
object

Specifies the high level purpose of the instruction based on a set of pre-defined categories. This is used by the initiating party to provide information concerning the processing of the payment. It is likely to trigger special processing by any of the agents involved in the payment chain.

Constraints: CMM16
businessfunction_entryclass
NACHA (string)

The payment network specific code corresponding to the business application or function for the transaction. This corresponds to the Business Application Identifier (BAI) in the case of Visa transactions, the Standard Entry Class (SEC) code in the case of ACH transactions and so on.

Constraints: CMM10
batch_type
required
string
Enum: "debit_batch" "credit_batch"
payment_info
credit_batch (object) or debit_batch (object)

Responses

201

The Payment object with id and confirmation mumber issued by Unified Money Movement Services.

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

Error Codes

The following table lists the business errors that need to be handled by the client.
click here

Events

Following events are triggered in the context of this API
moneymovementservices.batch.status_updated
post/masspayment/inquirebatch
https://api.orbipay.com/umm/v1/masspayment/inquirebatch

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Submit Credit Batch

|

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:business_transfers

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party, client_agent, external_agent

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

processing_mode
string

Indicates whether the transaction will be processed synchronously or asynchronously, in a non-blocking fashion.

Possible Values :
synchronous The transaction will be processed in a blocking fashion. default
asynchronous The transaction will be processed in a non-blocking fashion.

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
batch_info
object
credit_batch
Array of objects

Responses

200

The request has succeeded.

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

Error Codes

The following table lists the business errors that need to be handled by the client.
click here

Events

Following events are triggered in the context of this API
moneymovementservices.batch.status_updated
post/masspayment/submitcreditbatch
https://api.orbipay.com/umm/v1/masspayment/submitcreditbatch

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Submit Debit Batch

|

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:business_transfers

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party, client_agent, external_agent

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

processing_mode
string

Indicates whether the transaction will be processed synchronously or asynchronously, in a non-blocking fashion.

Possible Values :
synchronous The transaction will be processed in a blocking fashion. default
asynchronous The transaction will be processed in a non-blocking fashion.

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
batch_info
object
debit_batch
Array of objects

Responses

200

The request has succeeded..

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

Error Codes

The following table lists the business errors that need to be handled by the client.
click here

Events

Following events are triggered in the context of this API
moneymovementservices.batch.status_updated
post/masspayment/submitdebitbatch
https://api.orbipay.com/umm/v1/masspayment/submitdebitbatch

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Confirm Batch

|

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:business_transfers

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party, client_agent, external_agent

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

processing_mode
string

Indicates whether the transaction will be processed synchronously or asynchronously, in a non-blocking fashion.

Possible Values :
synchronous The transaction will be processed in a blocking fashion. default
asynchronous The transaction will be processed in a non-blocking fashion.

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
id
string [ 1 .. 50 ] characters
batch_reference
required
string [ 1 .. 50 ] characters

The unique identifier that the bank might want to assign for the batch.

requested_execution_date
string

Requested Execution date.

Responses

200

The Batch object with id issued by Unified Money Movement Services.

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

Error Codes

The following table lists the business errors that need to be handled by the client.
click here

Events

Following events are triggered in the context of this API
moneymovementservices.batch.status_updated
post/masspayment/confirmbatch
https://api.orbipay.com/umm/v1/masspayment/confirmbatch

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Cancel Batch

This API is used to cancel the Batch.

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:business_transfers

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party, client_agent, external_agent

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

processing_mode
string

Indicates whether the transaction will be processed synchronously or asynchronously, in a non-blocking fashion.

Possible Values :
synchronous The transaction will be processed in a blocking fashion. default
asynchronous The transaction will be processed in a non-blocking fashion.

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
id
string [ 1 .. 50 ] characters
batch_reference
required
string [ 1 .. 50 ] characters

The unique identifier that the bank might want to assign for the batch.

Responses

200

The Batch object with id issued by Unified Money Movement Services.

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

Error Codes

The following table lists the business errors that need to be handled by the client.
click here

Events

Following events are triggered in the context of this API
moneymovementservices.batch.status_updated
post/masspayment/cancelbatch
https://api.orbipay.com/umm/v1/masspayment/cancelbatch

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Fund Account

Collect Fund

Collect Fund API is used to collect the fund for newly opened account.

query Parameters
name_match
string

Indicates card account name match strategy to be followed.

Possible Values :
strict complete name match only.
lenient complete or partial name match, name match not supported for card.
ignore name match not required. default

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:account_opening

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

processing_mode
string

Indicates whether the transaction will be processed synchronously or asynchronously, in a non-blocking fashion.

Possible Values :
synchronous The transaction will be processed in a blocking fashion. default
asynchronous The transaction will be processed in a non-blocking fashion.

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
source
required
object

The JSON that contains all the attributes of party opening the account.

source_account
required
card_account (object)

The account used to fund the newly opened account.

destination
required
object

The party who is opening the account.

amount
required
object

Initial deposits to the account being opened.

fee
object

The total charges levied to the customer for account opening.

payment_reference
required
string [ 1 .. 36 ] characters [0-9a-zA-Z_-]{1,36}

The unique identifier that the bank might want to assign for the payment.

fulfilment_type
string
Value: "instant"
remittance_info
object

Information supplied to enable the matching/reconciliation of the payment.

Responses

201

The Payment object with id and confirmation mumber issued by Unified Money Movement Services.

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

Events

Following events are triggered in the context of this API
moneymovementservices.payment.status_updated
post/fundaccount/collectfund
https://api.orbipay.com/umm/v1/fundaccount/collectfund

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Settle Fund

Settle Fund API is used to settle the fund collected using the Collect Fund API to the respective DDAs being opened or the associated fee and other charges accounts.

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:account_opening

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

processing_mode
string

Indicates whether the transaction will be processed synchronously or asynchronously, in a non-blocking fashion.

Possible Values :
synchronous The transaction will be processed in a blocking fashion. default
asynchronous The transaction will be processed in a non-blocking fashion.

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
source
required
object

The JSON that contains all the attributes of party opening the account.

destination
required
object

The recipient of funds.

destination_account
required
bank_account (object)

Indicates the recipient account of the payment.

amount
required
object

Amount being settled.

payment_reference
required
string [ 1 .. 36 ] characters [0-9a-zA-Z_-]{1,36}

The unique identifier that the bank might want to assign for the payment.

end_to_end_reference
required
string [ 1 .. 35 ] characters

The reference for the payment that is passed on from the initiator to the recipient. This is the reference that traces the entire flow of the payment. However, please note that certain payment rails do not support an end to end reference.The maximum length for the end_to_end_reference varies across different payment rails and is outlined below

Payment Method Max Length Sent to Network
RTP 35 Yes
FEDNOW 35 Yes
FEDWIRE 35 Yes
ACH 15 Yes
CARD_VISA 16 No

fulfilment_type
string
Enum: "instant" "instant.BOOK_TRANSFER" "instant.TCH_RTP" "instant.FEDNOW"
remittance_info
object

Information supplied to enable the matching/reconciliation of the payment.

Responses

201

The Payment object with id and confirmation mumber issued by Unified Money Movement Services.

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

Events


moneymovementservices.payment.status_updated
post/fundaccount/settlefund
https://api.orbipay.com/umm/v1/fundaccount/settlefund

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

XB Transfer

Prepare XB Transfer

Create Simple XB Transfer API is used to transfer funds from a customer's bank account to another bank account cross broder without explicitly adding a beneficiary or beneficiary account. This is useful when the customer wants to make a one-off payment to an account.

header Parameters
client_key
required
any

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
any

The product identifier corresponding to the API.
Possible values:business_transfers

payment_channel
required
any

The FI channel vide which the API is invoked.
Possible values:business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
any

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
any

Identifies the requestor type for the API request.
Possible values:party

client_requestor_reference
any

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
any

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
any

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
any

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
any

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

X-PAAS-Headers
any

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
source
required
object

The JSON that contains all the attributes of customer to be created.

source_account
required
bank_account (object)

Indicates source account

destination
required
object

The recipient of funds .

destination_account
required
xb_bank_account (object)

Indicates the recipient account of the payment.

fulfilment_type
required
string
Enum: "xb.ach" "xb.wire" "xb.ach.convera" "xb.wire.convera" "xb.ach.tmate" "xb.wire.tmate"
amount
required
object

The amount being transfered from the source account to the destination account.

fee
object

The fee being charged for the transfer being made.

payment_reference
required
string [ 1 .. 36 ] characters [0-9a-zA-Z_-]{1,36}

The unique identifier that the bank might want to assign for the payment.

end_to_end_reference
required
string [ 1 .. 35 ] characters

The reference for the payment that is passed on from the initiator to the recipient. This is the reference that traces the entire flow of the payment. However, please note that certain payment rails do not support an end to end reference.The maximum length for the end_to_end_reference varies across different payment rails and is outlined below

Payment Method Max Length Sent to Network
RTP 35 Yes
FEDNOW 35 Yes
FEDWIRE 35 Yes
ACH 15 Yes
CARD_VISA 16 No

uetr
string

The unique transaction identifier.

businessfunction_entryclass
NACHA (string)

The payment network specific code corresponding to the business application or function for the transaction. This corresponds to the Business Application Identifier (BAI) in the case of Visa transactions, the Standard Entry Class (SEC) code in the case of ACH transactions and so on.

remittance_info
object

Information supplied to enable the matching/reconciliation of an entry with the item(s) that the payout is intended to settle, such as bills or RFPs received.

purpose
object

Underlying reason for the payment transaction. Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.

instruction_for_fi
Array of objects
approval_info
Array of objects

Information about who has created and approved the payment.

payment_category
object

Specifies the high level purpose of the instruction based on a set of pre-defined categories. This is used by the initiating party to provide information concerning the processing of the payment. It is likely to trigger special processing by any of the agents involved in the payment chain.

Constraints: CMM16

Responses

201

The Payment object with id and confirmation mumber issued by Unified Money Movement Services.

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

Events

Following events are triggered in the context of this API
moneymovementservices.payment.status_updated
post/xbtransfer/preparetransfer
https://api.orbipay.com/umm/v1/xbtransfer/preparetransfer

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Perform XB Transfer

Perform XB payment.

query Parameters
approval
string

Indicates if approval is required or not before processing the transaction.

Possible Values :
required Approval is required.
not_required Approval is not required. default

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:business_transfers

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

processing_mode
string

Indicates whether the transaction will be processed synchronously or asynchronously, in a non-blocking fashion.

Possible Values :
synchronous The transaction will be processed in a blocking fashion. default
asynchronous The transaction will be processed in a non-blocking fashion.

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
payment_reference
string [ 1 .. 36 ] characters [0-9a-zA-Z_-]{1,36}

The unique identifier that the bank might want to assign for the payment.

Constraints: CMM11
id
string

The unique identifier assigned by Unified Money Movement Services to payment.

Constraints: CMM11

Responses

201

The Payment object with id and confirmation mumber issued by Unified Money Movement Services.

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

412

The Payment object with id returned by Unified Money Movement Services when precondition fails.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

post/xbtransfer/performtransfer
https://api.orbipay.com/umm/v1/xbtransfer/performtransfer

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Cancel XB Transfer

Cancel XB payemnt.

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:business_transfers

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
id
string

The unique identifier assigned by Unified Money Movement Services to payment.

Constraints: CMM11
payment_reference
string [ 1 .. 36 ] characters [0-9a-zA-Z_-]{1,36}

The unique identifier that the bank might want to assign for the payment.

Constraints: CMM11
confirmation_number
string [ 1 .. 30 ] characters [a-zA-Z0-9]+

The confirmation number or reference provided to the customer for the payment.

comment
string [ 1 .. 140 ] characters [a-zA-Z0-9]+

The reason for cancelling the transfer.

Responses

200

The Payment object with id and confirmation mumber issued by Unified Money Movement Services.

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

post/xbtransfer/canceltransfer
https://api.orbipay.com/umm/v1/xbtransfer/canceltransfer

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

RFP

Send RFP

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:business_transfers

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

processing_mode
string

Indicates whether the transaction will be processed synchronously or asynchronously, in a non-blocking fashion.

Possible Values :
synchronous The transaction will be processed in a blocking fashion. default
asynchronous The transaction will be processed in a non-blocking fashion.

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
source
object

The JSON that contains all the attributes of source or the customer initaiting the payment.

source_account
object

Indicates the sender account of the RFP.

destination
object
destination_account
required
object

Indicates the recipient account of the payout.

amount
required
Array of objects

amount

amount_modification_allowed
boolean
Enum: true false

Indicates if the person is allowed to pay a different amount then the requested amount.

requested_execution_date
required
string
expiry_date
string
early_payment_allowed
boolean
Enum: true false

Indicates if the person is allowed to pay before the requested execution date.

additional_info
object

Information supplied to enable the matching/reconciliation of an entry with the item(s) that the payout is intended to settle, such as bills or RFPs received.

rfp_reference
required
string

The rfp reference assigned by the client to the original rfp.

Responses

200

Success

400

Bad Request

500

System Error.

502

Server Error.

Events

Following events are triggered in the context of this API
moneymovementservices.rfp.rfp_updated
moneymovementservices.rfp.payment_recieved
post/request/smbsendrfp
https://api.orbipay.com/umm/v1/request/smbsendrfp

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Payout

Create Payout

Create Simple Payout API allows a business to initiate a one-time transfer of funds to a recipient's bank account or debit card.

Update on TCH Operating Rule Compliance :
For clients who are intermediaries, utilizing a preconfigured account to fulfill debits involving ultimate debtors, the system will now use the following rules when passing information to the payment network.

Debtor Account Original Source Source in Request Debtor Name Sent to the Network Debtor Account Name Sent to the Network
Pre-configured FBO Account API request N/A Pre-configured Funding Account (FBO) A/c. nameOnAccount + originalSourceName Pre-configured Funding Account (FBO) A/c. nameOnAccount + originalSourceName
Pre-configured FBO Account N/A N/A Pre-configured Funding Account (FBO) A/c. nameOnAccount Pre-configured Funding Account (FBO) A/c. nameOnAccount

query Parameters
name_match
string

Indicates card account name match strategy to be followed.

Possible Values :
strict complete name match only.
lenient complete or partial name match, name match not supported for card.
ignore name match not required. default

approval
string

Indicates if approval is required or not before processing the transaction.

Possible Values :
required Approval is required.
not_required Approval is not required. default

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:payouts

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:retail_banking, business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party, client_agent, external_agent

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

processing_mode
string

Indicates whether the transaction will be processed synchronously or asynchronously, in a non-blocking fashion.

Possible Values :
synchronous The transaction will be processed in a blocking fashion. default
asynchronous The transaction will be processed in a non-blocking fashion.

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
source
object

The JSON that contains all the attributes of customer to be created.

source_account
bank_account (object)

Indicates source account

original_source
object

The name of the actual payer or the ultimate debtor.

destination
object

The recipient of funds .

ultimate_destination
object

The actual recipient of funds or the ultimate creditor. This could be different from the entity whose account is being credited.

destination_account
required
bank_account (object) or card_account (object)

Indicates the recipient account of the payment.

intermediary_agent
Array of objects

Intermediary Agent

amount
required
object

The amount being transfered from the source account to the destination account.

fee
object

The fee being charged for the transfer being made.

payment_reference
required
string [ 1 .. 36 ] characters [0-9a-zA-Z_-]{1,36}

The unique identifier that the bank might want to assign for the payment.

end_to_end_reference
required
string [ 1 .. 35 ] characters

The reference for the payment that is passed on from the initiator to the recipient. This is the reference that traces the entire flow of the payment. However, please note that certain payment rails do not support an end to end reference.The maximum length for the end_to_end_reference varies across different payment rails and is outlined below

Payment Method Max Length Sent to Network
RTP 35 Yes
FEDNOW 35 Yes
FEDWIRE 35 Yes
ACH 15 Yes
CARD_VISA 16 No

uetr
string [ 1 .. 36 ] characters [a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}

The Universally unique identifier that the bank might want to assign a unique end-to-end reference of a payment transaction.

fulfilment_type
string
Enum: "instant" "regular" "instant.BOOK_TRANSFER" "instant.TCH_RTP" "instant.FEDNOW" "instant.CARD_VISA" "urgent.SAMEDAY_ACH" "urgent.FEDWIRE" "regular.ACH"
payment_date
string 10 characters YYYY-MM-DD
businessfunction_entryclass
VISA (string) or NACHA (string)

The payment network specific code corresponding to the business application or function for the transaction. This corresponds to the Business Application Identifier (BAI) in the case of Visa transactions, the Standard Entry Class (SEC) code in the case of ACH transactions and so on.

purpose
object

Underlying reason for the payment transaction. Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.

instruction_for_fi
Array of objects
remittance_info
object

Information supplied to enable the matching/reconciliation of an entry with the item(s) that the payout is intended to settle, such as bills or RFPs received.

related_remittance_info
object
approval_info
Array of objects

Information about who has created and approved the payment.

Responses

201

The Payment object with id and confirmation mumber issued by Unified Money Movement Services.

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

Events

Following events are triggered in the context of this API
fasterpayouts.payout.status_updated
moneymovementservices.payment.payment_originated
moneymovementservices.payment.payment_updated
post/pay/simplepayout
https://api.orbipay.com/umm/v1/pay/simplepayout

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Prepare Payout

Prepare Create Simple Payout API allows a business to validate and review transfer requests before initiating one-time transfer of funds to a recipient's bank account or debit card.

Update on TCH Operating Rule Compliance :
For clients who are intermediaries, utilizing a preconfigured account to fulfill debits involving ultimate debtors, the system will now use the following rules when passing information to the payment network.

Debtor Account Original Source Source in Request Debtor Name Sent to the Network Debtor Account Name Sent to the Network
Pre-configured FBO Account API request N/A Pre-configured Funding Account (FBO) A/c. nameOnAccount + originalSourceName Pre-configured Funding Account (FBO) A/c. nameOnAccount + originalSourceName
Pre-configured FBO Account N/A N/A Pre-configured Funding Account (FBO) A/c. nameOnAccount Pre-configured Funding Account (FBO) A/c. nameOnAccount

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:payouts

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:retail_banking, business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party, client_agent, external_agent

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

processing_mode
string

Indicates whether the transaction will be processed synchronously or asynchronously, in a non-blocking fashion.

Possible Values :
synchronous The transaction will be processed in a blocking fashion. default
asynchronous The transaction will be processed in a non-blocking fashion.

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
source
object

The JSON that contains all the attributes of customer to be created.

source_account
bank_account (object)

Indicates source account

original_source
object

The name of the actual payer or the ultimate debtor.

destination
object

The recipient of funds .

ultimate_destination
object

The actual recipient of funds or the ultimate creditor. This could be different from the entity whose account is being credited.

destination_account
required
bank_account (object) or card_account (object)

Indicates the recipient account of the payment.

intermediary_agent
Array of objects

Intermediary Agent

amount
required
object

The amount being transfered from the source account to the destination account.

fee
object

The fee being charged for the transfer being made.

payment_reference
required
string [ 1 .. 36 ] characters [0-9a-zA-Z_-]{1,36}

The unique identifier that the bank might want to assign for the payment.

end_to_end_reference
required
string [ 1 .. 35 ] characters

The reference for the payment that is passed on from the initiator to the recipient. This is the reference that traces the entire flow of the payment. However, please note that certain payment rails do not support an end to end reference.The maximum length for the end_to_end_reference varies across different payment rails and is outlined below

Payment Method Max Length Sent to Network
RTP 35 Yes
FEDNOW 35 Yes
FEDWIRE 35 Yes
ACH 15 Yes
CARD_VISA 16 No

uetr
string [ 1 .. 36 ] characters [a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}

The Universally unique identifier that the bank might want to assign a unique end-to-end reference of a payment transaction.

fulfilment_type
string
Enum: "instant" "regular" "instant.BOOK_TRANSFER" "instant.TCH_RTP" "instant.FEDNOW" "instant.CARD_VISA" "urgent.SAMEDAY_ACH" "urgent.FEDWIRE" "regular.ACH"
payment_date
string 10 characters YYYY-MM-DD
businessfunction_entryclass
VISA (string) or NACHA (string)

The payment network specific code corresponding to the business application or function for the transaction. This corresponds to the Business Application Identifier (BAI) in the case of Visa transactions, the Standard Entry Class (SEC) code in the case of ACH transactions and so on.

purpose
object

Underlying reason for the payment transaction. Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.

instruction_for_fi
Array of objects
remittance_info
object

Information supplied to enable the matching/reconciliation of an entry with the item(s) that the payout is intended to settle, such as bills or RFPs received.

related_remittance_info
object

Responses

201

The Payment object with id and confirmation mumber issued by Unified Money Movement Services.

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

post/pay/preparepayout
https://api.orbipay.com/umm/v1/pay/preparepayout

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

RFP

Accept / Reject RFP

path Parameters
rfp_id
required
string

The unique identifier assigned to rfp..

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:collections

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:retail_banking, business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
action
string
Enum: "accepted" "rejected"

Specifies whether the Request for Payment (RFP) is accepted or rejected.

comment
string [ 1 .. 100 ] characters [0-9a-zA-Z._-]{0,100}

Customer’s comments or memo on the RFP being accepted or rejected.

Responses

200

Success

400

Bad Request

500

System Error.

502

Server Error.

post/rfp/{rfp_id}/review
https://api.orbipay.com/umm/v1/rfp/{rfp_id}/review

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

RFP

Send RFP

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:collections

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:retail_banking, business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

processing_mode
string

Indicates whether the transaction will be processed synchronously or asynchronously, in a non-blocking fashion.

Possible Values :
synchronous The transaction will be processed in a blocking fashion. default
asynchronous The transaction will be processed in a non-blocking fashion.

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
destination
object
destination_account
required
object

Indicates the recipient account of the payout.

amount
required
Array of objects

amount

amount_modification_allowed
boolean
Enum: true false

Indicates if the person is allowed to pay a different amount then the requested amount.

requested_execution_date
required
string
expiry_date
string
early_payment_allowed
boolean
Enum: true false

Indicates if the person is allowed to pay before the requested execution date.

additional_info
object

Information supplied to enable the matching/reconciliation of an entry with the item(s) that the payout is intended to settle, such as bills or RFPs received.

rfp_reference
required
string

The rfp reference assigned by the client to the original rfp.

Responses

201

Success

400

Bad Request

500

System Error.

502

Server Error.

Events

Following events are triggered in the context of this API
moneymovementservices.rfp.rfp_updated
moneymovementservices.rfp.payment_recieved
post/request/sendrfp
https://api.orbipay.com/umm/v1/request/sendrfp

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Cancel RFP

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:collections

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:retail_banking, business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
id
required
string [ 0 .. 20 ] characters [0-9]{1,20}

The unique identifier assigned to rfp.

external_reference
string [ 0 .. 50 ] characters [0-9a-zA-Z._-]{0,50}

The unique identifier that the client might want to assign for the rfp.

cancellation_reason
string [ 1 .. 100 ] characters [0-9a-zA-Z._-]{0,50}

The Cancellaton reason.

reject_payment
boolean
Enum: true false

Indicates if the cancellation is not possible the if payment should be rejected or not.

Responses

200

Success

400

Bad Request

500

System Error.

502

Server Error.

post/request/cancelrfp
https://api.orbipay.com/umm/v1/request/cancelrfp

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Liquidity Management

Create Simple FI Credit Transfer

Liquidity management Transfer API is used to transfer between FI to FI.

query Parameters
approval
string

Indicates if approval is required or not before processing the transaction.

Possible Values :
required Approval is required.
not_required Approval is not required. default

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:payouts

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:retail_banking, business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party, client_agent, external_agent

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

processing_mode
string

Indicates whether the transaction will be processed synchronously or asynchronously, in a non-blocking fashion.

Possible Values :
synchronous The transaction will be processed in a blocking fashion. default
asynchronous The transaction will be processed in a non-blocking fashion.

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
source
object

The JSON that contains all the attributes of customer to be created.

source_account
required
bank_account (object) or general_ledger (object)

Indicates source account

destination
object

The recipient of funds .

destination_account
required
bank_account (object)

Indicates the recipient account of the payment.

amount
required
object

The amount being transfered from the source account to the destination account.

payment_reference
required
string [ 1 .. 36 ] characters [0-9a-zA-Z_-]{1,36}

The unique identifier that the bank might want to assign for the payment.

end_to_end_reference
required
string [ 1 .. 16 ] characters

The reference for the payment that is passed on from the initiator to the recipient. This is the reference that traces the entire flow of the payment.

uetr
string [ 1 .. 36 ] characters [a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}

The Universally unique identifier that the bank might want to assign a unique end-to-end reference of a payment transaction.

fulfilment_type
string
Value: "urgent.FEDWIRE"
payment_date
string 10 characters

The date on which the payment is scheduled to be made. It must be in ISO8601 full-date format, namely, YYYY-MM-DD.

purpose
object

Underlying reason for the payment transaction. Purpose is used by the end-customers, that is initiating party, (ultimate) debtor, (ultimate) creditor to provide information concerning the nature of the payment. Purpose is a content element, which is not used for processing by any of the agents involved in the payment chain.

instruction_for_fi
Array of objects
remittance_info
object

Information supplied to enable the matching/reconciliation of an entry with the item(s) that the payout is intended to settle, such as bills or RFPs received.

approval_info
Array of objects

Information about who has created and approved the payment.

Responses

201

The Payment object with id and confirmation mumber issued by Unified Money Movement Services.

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

Events

Following events are triggered in the context of this API
moneymovementservices.payment.status_updated
post/liquiditymgmt/ficredittransfer
https://api.orbipay.com/umm/v1/liquiditymgmt/ficredittransfer

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Reverse

Send RROF

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:retail_transfers, business_transfers,payouts

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:retail_banking, business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
original_id
string [ 0 .. 20 ] characters [0-9]{1,20}

The id assigned by Unified Money Movement Services to the original payment.

original_payment_reference
string [ 0 .. 36 ] characters [0-9a-zA-Z_-]{1,36}

The payment reference assigned by the client to the original payment.

reason_info
object

The reason codes for which RROF is initiated.

Responses

200

Success

400

Bad Request

500

System Error.

502

Server Error.

Events

Following events are triggered in the context of this API
moneymovementservices.rrof.status_updated
post/return/sendrrof
https://api.orbipay.com/umm/v1/return/sendrrof

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Reverse ACH Payment

|

query Parameters
approval
string

Indicates if approval is required or not before processing the transaction.

Possible Values :
required Approval is required.
not_required Approval is not required. default

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:business_transfers

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:retail_banking, business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party, client_agent, external_agent

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

processing_mode
string

Indicates whether the transaction will be processed synchronously or asynchronously, in a non-blocking fashion.

Possible Values :
synchronous The transaction will be processed in a blocking fashion. default
asynchronous The transaction will be processed in a non-blocking fashion.

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
One of
  • With Original Payment Id
id
required
string [ 1 .. 36 ] characters [0-9a-zA-Z_-]{1,36}

The unique identifier assigned by Unified Money Movement Services to the original payment recorded in the system. This is the id assigned for the payment received that can be found in the webhook corresponding to the original payment received.

return_reason_info
object

Indicates return code for the payment.

return_reference
required
string [ 1 .. 36 ] characters [0-9a-zA-Z_-]{1,36}

The unique identifier that the bank might want to assign for the return originated.

amount
object

The amount being returned. The entire amount will be returned if this is not specified.

Responses

201

The Payment object with id and confirmation mumber issued by Unified Money Movement Services.

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

post/return/reverseachpayment
https://api.orbipay.com/umm/v1/return/reverseachpayment

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Return

Return Payment

|

query Parameters
approval
string

Indicates if approval is required or not before processing the transaction.

Possible Values :
required Approval is required.
not_required Approval is not required. default

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:payouts

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:retail_banking, business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party, client_agent, external_agent

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
One of
  • With Original Payment Id
id
required
string [ 1 .. 36 ] characters [0-9a-zA-Z_-]{1,36}

The unique identifier assigned by Unified Money Movement Services to the original payment recorded in the system. This is the id assigned for the payment received that can be found in the webhook corresponding to the original payment received.

return_reason_info
object

Indicates return code for the payment.

return_reference
required
string [ 1 .. 36 ] characters [0-9a-zA-Z_-]{1,36}

The unique identifier that the bank might want to assign for the return originated.

amount
object

The amount being returned. The entire amount will be returned if this is not specified.

Responses

201

The Payment object with id and confirmation mumber issued by Unified Money Movement Services.

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

Events

Following events are triggered in the context of this API
moneymovementservices.return.return_originated
moneymovementservices.return.return_updated
post/return/returnpayment
https://api.orbipay.com/umm/v1/return/returnpayment

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Cancel

Cancel Payment

Cancel Payment Api will cancel the scheduled payments.

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:retail_transfers, business_transfers,payouts,account_opening,collections

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:retail_banking, business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
payment_reference
string [ 1 .. 36 ] characters [0-9a-zA-Z_-]{1,36}

The unique identifier that the bank might want to assign for the payment.

Constraints: CMM11
id
string

The unique identifier assigned by Unified Money Movement Services to payment.

Constraints: CMM11
notes
string

memo or comment.

Responses

200

The Payment object with id and confirmation mumber issued by Unified Money Movement Services.

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

Error Codes

The following table lists the business errors that need to be handled by the client.
click here

Events

Following events are triggered in the context of this API
moneymovementservices.payment.payment_updated
post/cancel/cancelpayment
https://api.orbipay.com/umm/v1/cancel/cancelpayment

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Status

Get Payment Status

Get Payment Status API returns the current status of payment.

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:retail_transfers, business_transfers,payouts,account_opening,collections

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:retail_banking, business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
payment_reference
string [ 1 .. 36 ] characters [0-9a-zA-Z_-]{1,36}

The unique identifier that the bank might want to assign for the payment.

Constraints: CMM11
id
string

The unique identifier assigned by Unified Money Movement Services to payment.

Constraints: CMM11

Responses

200

The Payment object with id and confirmation mumber issued by Unified Money Movement Services.

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

post/status/getpaymentstatus
https://api.orbipay.com/umm/v1/status/getpaymentstatus

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Get RFP Status

Get RFP Status API returns the current status of RFP.

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:collections

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:retail_banking, business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
rfp_reference
string [ 1 .. 16 ] characters [0-9a-zA-Z_-]{1,16}

The unique identifier that the bank might want to assign for the RFP.

Constraints: CMM11
id
string

The unique identifier assigned by Unified Money Movement Services to RFP.

Constraints: CMM11

Responses

200

The Payment object with id and confirmation mumber issued by Unified Money Movement Services.

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

post/status/getrfpstatus
https://api.orbipay.com/umm/v1/status/getrfpstatus

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Ancillary

Get Routing Details

The API is used to get information on the Routing and Transit Number. It returns the details of the corresponding Participant in the RTP Network, the RTP messages that it supports and the current status of the participant.

path Parameters
routing_number
required
string

The routing number.

query Parameters
fulfilment_type
Array of strings
Items Enum: "instant" "regular" "instant.TCH_RTP" "instant.FEDNOW" "urgent.SAMEDAY_ACH" "urgent.FEDWIRE" "regular.ACH"

Filters the results based on the specified fulfilment types Example: fulfilment_type=instant&fulfilment_type=regular&fulfilment_type=urgent.FEDWIRE

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:retail_transfers, business_transfers,collections,payouts,account_opening

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:retail_banking, business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

get/route/routingdetails/{routing_number}
https://api.orbipay.com/umm/v1/route/routingdetails/{routing_number}

Please click on a language icon above to try out the API

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Get Indicative Rate

The API is used to get the current flex rate of the given currency

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:retail_transfers, business_transfers,collections,payouts,account_opening

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:retail_banking, business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
send_country
string

send country

send_currency
string

send currency

receive_country
string

receive country

receive_currency
string

receive currency

specified_amount
string

specified amount

specified_currency
string

specified currency

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

post/rates/indicativerates
https://api.orbipay.com/umm/v1/rates/indicativerates

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Verify Card Details

The API is used to validate a card for payment.

query Parameters
name_match
string

Indicates card account name match strategy to be followed.

Possible Values :
strict complete name match only.
lenient complete or partial name match, name match not supported for card.
ignore name match not required. default

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:retail_transfers, business_transfers,collections,payouts,account_opening

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:retail_banking, business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
businessfunction_entryclass
VISA (string)

The payment network specific code corresponding to the business application or function for the transaction. This corresponds to the Business Application Identifier (BAI) in the case of Visa transactions.

card_account
object

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

post/card/verify
https://api.orbipay.com/umm/v1/card/verify

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Find Bank

The API is used to get bank details. One of the following combinations of parameters is required to search for the bank effectively.

IBAN + IBAN Country Code
Bank Code + Address Country Code
Bank Branch Code + Address Country Code
Address Country Code + City + Bank Name + any other parameters

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:retail_transfers, business_transfers, payouts

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:retail_banking, business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
iban
string
iban_country_code
string
bank_code
string
bank_name
string
bank_branch_code
string
address
object

The postal address .

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

post/route/bankdetails
https://api.orbipay.com/umm/v1/route/bankdetails

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Get Payment Data Fields

The API is used to get the field details required to make the payment.

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:retail_transfers, business_transfers,payouts

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:retail_banking, business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
destination_bank_country_code
required
string <[A-Z]{2,2}>

The country code of the recipient bank.

currency_code
required
string <[A-Z]{3,3}>

The currency code.

destination_country_code
string <[A-Z]{2,2}>

The country code of the recipient. This can be different from the recipient's bank country.

payment_method
string


Possible Values :- XB_ACH, XB_WIRE

party_type
string

Entity type

Possible Values :
INDIVIDUAL,BUSINESS

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

post/route/getpaymentdatafields
https://api.orbipay.com/umm/v1/route/getpaymentdatafields

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

List Supported Corridors

The API is used to get the list of supported corridores.

query Parameters
destination_country_code
string

Country code filter(Ex- GB, IN, US etc..)

payment_method_name
string

Payment method filter.
Example Value :- XB_WIRE, XB_ACH

header Parameters
client_key
required
any

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
any

The product identifier corresponding to the API.
Possible values:retail_transfers,business_transfers,payouts

payment_channel
required
any

The FI channel vide which the API is invoked.
Possible values:retail_banking, business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
any

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
any

Identifies the requestor type for the API request.
Possible values:party

client_requestor_reference
any

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
any

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
any

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
any

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
any

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

X-PAAS-Headers
any

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

get/route/supportedcorridors/
https://api.orbipay.com/umm/v1/route/supportedcorridors/

Please click on a language icon above to try out the API

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
]

Calculate Fee

The API is used to evaluate the fee for a transaction.

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:retail_transfers, business_transfers,account_opening,collections,payouts

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:retail_banking, business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
source
required
object

The JSON that contains all the attributes of source or the customer initaiting the payment.

source_account
required
bank_account (object) or card_account (object)

Indicates source account

destination
object

The recipient of funds if the recipient is different from the customer.

destination_account
required
bank_account (object) or card_account (object)

Indicates the recipient account of the payment.

amount
required
object

The amount being transfered from the source account to the destination account.

businessfunction_entryclass
VISA (string) or NACHA (string)

The payment network specific code corresponding to the business application or function for the transaction. This corresponds to the Business Application Identifier (BAI) in the case of Visa transactions, the Standard Entry Class (SEC) code in the case of ACH transactions and so on.

fulfilment_type
required
string
Enum: "instant" "regular" "regular.ACH" "urgent.ACH" "instant.TCH_RTP" "instant.FEDNOW" "urgent.FEDWIRE" "xb.wire"

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

Error Codes

The following table lists the business errors that need to be handled by the client.
click here
post/calculatefee
https://api.orbipay.com/umm/v1/calculatefee

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Fetch Fee

This API fetches the applicable fees based on the provided details across multiple supported payment rails.

header Parameters
client_key
required
string

The unique identifier assigned to the client.
Example:CLIAAADDD0910

product
required
string

The product identifier corresponding to the API.
Possible values:retail_transfers, business_transfers,account_opening,collections,payouts

payment_channel
required
string

The FI channel vide which the API is invoked.
Possible values:retail_banking, business_banking, smb_banking, bank_bos, atm, kiosk, pos, mobile_banking, csm, online

access_channel
string

This is internal channel through which the API is invoked.
Example:web_portal, agent

requestor_type
required
string

Identifies the requestor type for the API request.
Possible values:party

client_requestor_reference
string

The identifier for the requestor of the API, in the client system. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

requestor
string

The identifier for the requestor of the API issued by Orbipay. Either the client_requestor_reference or the requestor has to be available in every API request for audit purposes.

context_variant
string

To be used if there's a need to provide additional contextual information. For future use.

idempotent_request_key
required
string

The unique token that clients can generate and maintain in order to identify an API request. This is used to identify duplicate requests and retrials.
Example:6bc5f0f49ee2412a93b0596d6a3c4eca

timestamp
required
string

The UTC datetime when the API is invoked, in the ISO 8601 format
Example:2020-09-18T17:31:34.000-05:30

X-PAAS-Headers
string

For additional context information such as end user IP address, session information and so on. The content is a list of key-value pairs separated by semicolon (;) where key and value are separated by equals sign(=).
Example:c_session_id=SADKAS2131312;c_ip=10.112.25.45

Request Body Schema: application/json
source
object

The JSON that contains all the attributes of source or the customer initaiting the payment.

source_account
required
bank_account (object) or card_account (object)

Indicates source account

destination
object

The recipient of funds if the recipient is different from the customer.

destination_account
required
bank_account (object) or card_account (object)

Indicates the recipient account of the payment.

amount
required
object

The amount being transfered from the source account to the destination account.

businessfunction_entryclass
VISA (string) or NACHA (string)

The payment network specific code corresponding to the business application or function for the transaction. This corresponds to the Business Application Identifier (BAI) in the case of Visa transactions, the Standard Entry Class (SEC) code in the case of ACH transactions and so on.

fulfilment_type
required
Array of strings

A list of fulfillment types can be provided to assess the applicable fees.
Possible values:- instant, regular, regular.ACH, urgent.ACH, instant.TCH_RTP, instant.FEDNOW, urgent.FEDWIRE, xb.WIRE, xb.ACH.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

The requested resource doesn't exist.

422

The parameters were valid but the request failed.

500

Something went wrong and the request could not be processed.

502

Server Error.

post/fetchfee
https://api.orbipay.com/umm/v1/fetchfee

Please click on a language icon above to try out the API

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
}