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 |
| name_match | string Indicates card account name match strategy to be followed. |
| approval | string Indicates if approval is required or not before processing the transaction. |
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| processing_mode | string Indicates whether the transaction will be processed synchronously or asynchronously, 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(=). |
| source | object The source of funds, or debtor. | ||||||||||||||||||
| 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 , or creditor . | ||||||||||||||||||
| 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) 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
| ||||||||||||||||||
| 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 an 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" Specifies the type and speed of payment processing. Enum values:
| ||||||||||||||||||
| 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. |
The Payment object with id and confirmation mumber issued by Unified Money Movement Services.
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
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 |
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| 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(=). |
| source | object The source of funds, or debtor. | ||||||||||||||||||
| 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 , or creditor . | ||||||||||||||||||
| 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) 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
| ||||||||||||||||||
| 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 an 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" Specifies the type and speed of payment processing. Enum values:
| ||||||||||||||||||
| 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 |
The Payment object with id and confirmation mumber issued by Unified Money Movement Services.
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
| name_match | string Indicates card account name match strategy to be followed. |
| approval | string Indicates if approval is required or not before processing the transaction. |
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| 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(=). |
| source required | object The source of funds, or debtor. | ||||||||||||||||||
| source_account | bank_account (object) Indicates source account Constraints: CMM21 | ||||||||||||||||||
| original_source | object The name of the actual payer or the ultimate debtor. | ||||||||||||||||||
| destination | object The recipient of funds , or creditor. | ||||||||||||||||||
| 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) 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
| ||||||||||||||||||
| fulfilment_type required | string Enum: "urgent.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 | ||||||||||||||||||
| frequency required | string Enum: "daily" "weekly" "biweekly" "monthly" "quarterly" "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. |
The Payment object with id and confirmation mumber issued by Unified Money Movement Services.
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| 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(=). |
| 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 |
The Payment object with id and confirmation mumber issued by Unified Money Movement Services.
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| 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(=). |
| 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.. |
The Payment object with id and confirmation mumber issued by Unified Money Movement Services.
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| 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(=). |
| 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. |
The Payment object with id and confirmation mumber issued by Unified Money Movement Services.
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
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.
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| 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(=). |
| 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"
|
| 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) |
The Payment object with id and confirmation mumber issued by Unified Money Movement Services.
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
|
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| processing_mode | string Indicates whether the transaction will be processed synchronously or asynchronously, 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(=). |
| batch_info | object |
| credit_batch | Array of objects |
The request has succeeded.
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
|
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| processing_mode | string Indicates whether the transaction will be processed synchronously or asynchronously, 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(=). |
| batch_info | object |
| debit_batch | Array of objects |
The request has succeeded..
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
|
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| 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(=). |
| 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. |
The Batch object with id issued by Unified Money Movement Services.
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
This API is used to cancel the Batch.
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| 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(=). |
| 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. |
The Batch object with id issued by Unified Money Movement Services.
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
Create Simple XB payout 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.
| client_key required | any The unique identifier assigned to the client. |
| product required | any The product identifier corresponding to the API. |
| payment_channel required | any The FI channel vide which the API is invoked. |
| access_channel | any This is internal channel through which the API is invoked. |
| requestor_type required | any Identifies the requestor type for the API request. |
| 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. |
| timestamp required | any The UTC datetime when the API is invoked, in the ISO 8601 format |
| 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(=). |
| source required | object The JSON that contains all the attributes of customer to be created. | ||||||||||||||||||
| source_account | bank_account (object) or general_ledger (object) Indicates source account | ||||||||||||||||||
| destination | object The recipient of funds , or creditor . Constraints: CMM20 | ||||||||||||||||||
| destination_account | xb_bank_account (object) Indicates the recipient account of the payment. Constraints: CMM20 | ||||||||||||||||||
| fulfilment_type required | string Enum: "xb.wire" "xb.wire.convera" | ||||||||||||||||||
| 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
| ||||||||||||||||||
| 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 | ||||||||||||||||||
| intermediary_agent | Array of objects Intermediary Agent |
The Payment object with id and confirmation mumber issued by Unified Money Movement Services.
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
Perform XB payout.
| approval | string Indicates if approval is required or not before processing the transaction. |
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| processing_mode | string Indicates whether the transaction will be processed synchronously or asynchronously, 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(=). |
| 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 |
The Payment object with id and confirmation mumber issued by Unified Money Movement Services.
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The Payment object with id returned by Unified Money Movement Services when precondition fails.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
Cancel XB payout.
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| 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(=). |
| 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. |
The Payment object with id and confirmation mumber issued by Unified Money Movement Services.
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| 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(=). |
| source required | object The recipient of the RFP or Debtor. | ||||||||||||
| source_account required | object Indicates the source of funds of the RFP or debtor account. | ||||||||||||
| amount required | Array of objects amount | ||||||||||||
| end_to_end_reference required | string [ 1 .. 35 ] characters [0-9a-zA-Z._-]{0,16} 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
| ||||||||||||
| fulfilment_type required | string Enum: "instant.TCH_RTP" "instant.FEDNOW" "urgent.FEDWIRE" Specifies the type and speed of payment processing. Enum values:
| ||||||||||||
| requested_execution_date required | string [0-9]{4}-[0-9]{2}-[0-9]{2} The date on which the debtor's account(s) is (are) to be debited. | ||||||||||||
| expiry_date | string [0-9]{4}-[0-9]{2}-[0-9]{2} The debtor must accept or reject the request by this specified date. After this date, the request becomes void and can no longer be processed; any payments received in response to the RFP will be rejected. | ||||||||||||
| 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. | ||||||||||||
| rfp_reference required | string [ 1 .. 36 ] characters [0-9a-zA-Z._-]{0,36} The unique identifier that the bank might want to assign for the RFP. |
Success
Bad Request
System Error.
Server Error.
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| 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(=). |
| id | string [ 0 .. 20 ] characters [0-9]{1,20} The unique identifier assigned to rfp. Constraints: CMM18 |
| rfp_reference | string [ 1 .. 36 ] characters [0-9a-zA-Z._-]{0,36} The unique identifier that the client might want to assign for the rfp. Constraints: CMM18 |
| cancellation_reason required | object |
| reject_payment | boolean Enum: true false Indicates whether the payment should be rejected if cancellation is not possible. |
Success
Bad Request
System Error.
Server Error.
| rfp_id required | string The unique identifier assigned to rfp.. |
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| 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(=). |
| action | string [ 0 .. 50 ] characters 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. |
Success
Bad Request
System Error.
Server Error.
Liquidity management Transfer API is used to transfer between FI to FI.
| approval | string Indicates if approval is required or not before processing the transaction. |
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| 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(=). |
| source | object The source of funds, or debtor. |
| source_account required | bank_account (object) or card_account (object) Indicates source account |
| destination | object The recipient of funds , or creditor. |
| 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 an 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. |
The Payment object with id and confirmation mumber issued by Unified Money Movement Services.
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
This Api can be used for both Credit Transfer and Direct Debit.
| approval | string Indicates if approval is required or not before processing the transaction. |
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| processing_mode | string Indicates whether the transaction will be processed synchronously or asynchronously, 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(=). |
| 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. |
The Payment object with id and confirmation mumber issued by Unified Money Movement Services.
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
|
| approval | string Indicates if approval is required or not before processing the transaction. |
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| 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(=). |
| 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. |
The Payment object with id and confirmation mumber issued by Unified Money Movement Services.
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| 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(=). |
| 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. |
Success
Bad Request
System Error.
Server Error.
|
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| 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(=). |
| 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. |
| org_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. "org_return_reference":"051405285000204", |
| dishonour_reference required | string [ 1 .. 36 ] characters [0-9a-zA-Z_-]{1,36} |
| amount required | object The amount being returned. The entire amount will be returned if this is not specified. |
The Payment object with id and confirmation mumber issued by Unified Money Movement Services.
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
Get Payment Status API returns the current status of payment.
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| 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(=). |
| 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 |
The Payment object with id and confirmation mumber issued by Unified Money Movement Services.
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
Get RFP Status API returns the current status of RFP.
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| 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(=). |
| 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 |
The Payment object with id and confirmation mumber issued by Unified Money Movement Services.
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
The API provides information about a Routing and Transit Number, including the identified participant in the requested network, the supported network messages, and the current status of the participant FI.
| routing_number required | string Routing number of the participant FI. |
| fulfilment_type | Array of strings Items Enum: "instant" "regular" "instant.TCH_RTP" "instant.FEDNOW" "urgent.SAMEDAY_ACH" "urgent.FEDWIRE" "regular.ACH" This should be provided as an input to check the availability of a routing number in a specific payment network. If not provided, the system will, by default, check availability in RTP and FedNow payment networks. More than one payment network can be provided by passing multiple fulfilment_type parameters in the request, as shown below. Example: |
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| 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(=). |
Success
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
The API is used to get the current flex rate of the given currency
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| 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(=). |
| 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 |
Success
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
The API is used to validate a card for payment.
| name_match | string Indicates card account name match strategy to be followed. |
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| 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(=). |
| 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 |
Success
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
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 |
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| 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(=). |
| iban | string |
| iban_country_code | string |
| bank_code | string |
| bank_name | string |
| bank_branch_code | string |
| address | object The postal address . |
Success
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
The API is used to get the field details required to make the payment.
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| 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(=). |
| 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
|
| party_type | string Entity type |
| fx_provider | string Enum: "xb.fx.convera" "xb.fx.wellsfargo" "xb.fx.stonex" Defines which FX provider should be used when fetching payment data fields. |
Success
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
The API is used to get the list of supported corridores.
| destination_country_code | string Country code filter(Ex- GB, IN, US etc..) |
| payment_method_name | string Payment method filter. |
| client_key required | any The unique identifier assigned to the client. |
| product required | any The product identifier corresponding to the API. |
| payment_channel required | any The FI channel vide which the API is invoked. |
| access_channel | any This is internal channel through which the API is invoked. |
| requestor_type required | any Identifies the requestor type for the API request. |
| 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. |
| timestamp required | any The UTC datetime when the API is invoked, in the ISO 8601 format |
| 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(=). |
Success
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
The API is used to evaluate the fee for a transaction.
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| 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(=). |
| source required | object The source of funds, or debtor. |
| source_account required | bank_account (object) or card_account (object) Indicates source account |
| destination | object The recipient of funds, or creditor. |
| 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" |
Success
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
This API fetches the applicable fees based on the provided details across multiple supported payment rails.
| client_key required | string The unique identifier assigned to the client. |
| product required | string The product identifier corresponding to the API. |
| payment_channel required | string The FI channel vide which the API is invoked. |
| access_channel | string This is internal channel through which the API is invoked. |
| requestor_type required | string Identifies the requestor type for the API request. |
| 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. |
| timestamp required | string The UTC datetime when the API is invoked, in the ISO 8601 format |
| 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(=). |
| source | object The source of funds, or debtor. |
| source_account required | bank_account (object) or card_account (object) Indicates source account |
| destination | object The recipient of funds, or creditor. |
| 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. |
Success
Bad Request
Unauthorized
Forbidden
The requested resource doesn't exist.
The parameters were valid but the request failed.
Something went wrong and the request could not be processed.
Server Error.
© 2022 Alacriti Payments LLC. All Rights Reserved
