Getting Started

The Payments API is a REST API that accepts standard HTTP commands (GET and POST), returns JSON-encoded responses, and uses standard HTTP response codes. The Payments service includes pre-defined domain-specific endpoints, such as banks and beneficiaries.

To use the Payments API, you must be authenticated by verifying your identity. See Authentication for more information.

To help you use the Payments API, we provide several use cases to get started and reference information that describes each API request in a consistent manner. These API request sections include:

In the Payments API, IDs are of type Varchar. This is important because IDs are often represented as numerical types.

Our mission is to provide customers with everything they need to use the Payments API effectively. If you have issues while using the API, discover shortcomings, or have suggestions for improvements, please do not hesitate to contact us.

Authentication

Information security is critical, especially in web-based applications. The Payments service uses the Oauth2 framework for advanced authentication. For details of the OAuth2 framework, see the OAuth2 website.

When you log in using your username and password, the Payments service generates an access token. You can use this token for verification in your API requests.

You include the token in the Authorization: Bearer… header for all interactions with the Payments API.

Authentication codes grant you special privileges to access and use the Payments API. Keep these codes safe and avoid sharing them in insecure environments.

Each client entity is considered unique and switching between entities will require a new /connect call and token. Partners are required to build any entity management functionality within their own system. This will also require a unique webhook URL per entity if webhooks are being utilized.

Authentication enables you to:

• Connect to the Payments Service
  When you connect (log in) to the Payments service, you receive an access token that you provide for verification in subsequent API requests. The access token is valid for a short time.

• Disconnect from the Payments Service
  When you disconnect from (log out of) the Payments service, you can no longer use API calls and the service revokes the access token granted to you when you logged in.

• Retrieve Historical Connection Information
  You can get information about past connections. You can specify the period from which you want to retrieve connection information and there are options for sorting the retrieved information.

POST Connect to the Payments Service

You connect to the Payments service to log in. You do this by sending an HTTP POST request with the required account login information to the /connect endpoint.

Endpoint: /connect

Request Body Payload Example

Example Request

Response Body Payload Example

Example Success Response

Example Error Responses

GET Disconnect from the Payments Service

You disconnect from the Payments service to log out. You do this by sending an HTTP GET request to the /disconnect endpoint. The access token that you used for API request verification while connected becomes invalid.

Endpoint: /disconnect

Response Body Payload Example

Example Success Response

Example Error Responses

POST Retrieve Historical Connection Information

You can retrieve details of historical Payments service connections within a specific time period. You do this by sending an HTTP POST request to the /connection_history endpoint. The response JSON structure contains details of each connection. The details include the user ID, the date and time, the IP address, the country, and the local date and time.

Endpoint: /connection_history

Request Body Payload Example

Example Request

Response Body Payload Example

Example Success Response

Example Error Responses

POST Change password for the Payment Service

First, you connect to the payments service to log in. You do this by sending an HTTP POST request with the required account login information to the /connect endpoint. Right after connecting to the payment service, you can change your password by sending an HTTP POST request with the required information to the /v2/change_password endpoint.

Endpoint: /v2/change_password

Request Body Payload Example

The request body includes the following parameters:

Example Request

Response Body Payload Example

If the change password request is successful, the service returns a response.

The response body includes the following parameters:

Example Success Response

Example Error Responses

Treasury Account Management

The TransferMate Payments API allows an authenticated user to manage personal bank account information. As a regulated entity and to ensure we follow anti-money laundering best-practice, TransferMate must collect the details of the funding bank account in every transaction. Before functionality of the account is enabled,a bank account needs to be created prior to any action.

Using our Payments API, an authenticated user can:

• Add a New Bank Account
  You add a new bank account by providing the account details. If the account is created successfully, the service assigns and returns an account ID. When you add a new bank account, the service performs rigorous validation and may report a variety of errors.

• View Existing Bank Account Details
  You can retrieve the details of existing bank accounts. There is an option to retrieve all active or inactive accounts and you can choose to paginate the results with a certain number of bank accounts presented per page.

• Edit Existing Bank Account Details
  You can edit a bank account name or deactivate an account. You cannot recover or re-use an inactive account. Inactive accounts are removed from all live lists. To view inactive accounts, see View Existing Bank Account Details.

• Verify Existing Bank Account Details
  You can verify the details of an existing bank account. The service uses an internal verifier to perform checks on the provided bank account details to ensure conformance to standards.

  To get meaningful results, you must provide at least an International Bank Account Number (IBAN), a Bank Information Code (BIC), or other pertinent bank identification information, for example, a bank number or sort code.

  The verifier returns codes and messages that explain the results of the verification. See Bank Verifier Codes and Messages for more information.

The information maintained for a bank account includes the following:

POST Add a New Bank Account - Scheduled to be deprecated - please see V2

You add a new bank account by sending an HTTP POST request with the required account information to the /add_bank endpoint.

In earlier versions of this API, you could add a new bank account with an HTTP POST request. The POST method is now deprecated in favor of the PUT request. We recommend that you use the PUT request because the POST method will be removed from future API versions.

Please note when creating a bank account if you select iban_3 as the value for account_number_type then validations will be done on the account_number field to ensure it is in a valid IBAN format.

If you select account_type_1 for account_number_type then the API requires you fill out the transit_code_type field and will validate the value of the transit_code field based on this value.

If using Direct Debit/Reverse Wire functionality, the account_name must match the name of the company as it appears on the company bank statement - this field cannot be edited.

Endpoint: /add_bank

Request Body Payload Example

The request body includes the following parameters:

Example Request

Response Body Payload Example

If the add bank request is successful and the service allocates an account ID, the service returns a response.

The response body includes the following parameters:

Example Success Response

Example Error Responses

If the add bank request is not successful, the service responds with an error code, rejects the request, and does not create the bank account. Some examples of error responses are provided.

The JSON structure associated with the error responses has the following parameters:

Error Code 531 - Account Exists, Unknown Currency, or Operation Unsuccessful.

Error Code 532 - One or More JSON Attributes Missing or Malformed

Error Code 533 - Invalid Token or Missing Return Data

POST Add a New Bank Account V2

You add a new bank account by sending an HTTP POST request with the required account information to the /v2/add_bank endpoint.

In earlier versions of this API, you could add a new bank account with an HTTP POST request. The POST method is now deprecated in favor of the PUT request. We recommend that you use the PUT request because the POST method will be removed from future API versions.

Please note when creating a bank account if you select iban_3 as the value for account_number_type then validations will be done on the account_number field to ensure it is in a valid IBAN format.

If you select account_type_1 for account_number_type then the API requires you fill out the transit_code_type field and will validate the value of the transit_code field based on this value.

If using Direct Debit/Reverse Wire functionality, the account_name must match the name of the company as it appears on the company bank statement - this field cannot be edited.

Endpoint:/v2/add_bank

Request Body Payload Example

Example Request

{
    "country_code": "IE",
    "currency_type_id": "EUR",
    "account_name": "New Account",
    "account_number_type": "iban_3",
    "account_number": "IE29AIBK93115312345678",
    "transit_code_type": " ",
    "transit_code": " ",
    "swift": "AIBKIE2D",
    "account_description": "Irish Bank"
}

Response Body Payload Example

If the add bank request is successful and the service allocates an account ID, the service returns a response.

Example Success Response

Example Error Responses

If the add bank request is not successful, the service responds with an error code, rejects the request, and does not create the bank account. Some examples of error responses are provided.

The JSON structure associated with the error responses has the following parameters:

Error Code 531 – Account Exists, Unknown Currency, or Operation Unsuccessful.

[
    {
        "ID": "account_number",
        "description": "Already exists!"
    },
    {
        "ID": "currency_id",
        "description": "Unknown currency"
    },
    {
        "ID": "db_action",
        "description": "Operation is not successful! Please try again."
    }
]

Error Code 532 – One or More JSON Attributes Missing or Malformed

{
    "stat": "One or More JSON Attributes Missing or Malformed: country_code"
}

Error Code 533 – Invalid Token or Missing Return Data

{
    "stat": "Invalid token or missing return data"
}

POST Verify Existing Bank Account Details

You can get a list of active or inactive bank accounts with details by sending an HTTP POST request to the /view_banks endpoint.

Optionally, you can paginate the results to retrieve a certain number of bank accounts per page. If there are more than 25 bank accounts in the response, pagination occurs automatically.

Endpoint: /view_banks

Request Body Payload Example

The request body includes the following parameters:

Example Request

Response Body Payload Example

If the view bank account details request is successful, the service returns a list of bank details. If pagination is requested then the metadata will be returned with information about this.

The response body includes the following parameters:

Example Success Response

The returned JSON structure is as follows for request with parameter "with_pagination_data":

The returned JSON structure is as follows for request without parameter "with_pagination_data":

Example Error Responses

If the view existing account request is not successful, the service returns an error code, rejects the request, and does not return the existing account details. The relevant error response is provided.

The JSON structure associated with the error responses has the following parameters:

{
    "is_successful": false,
    "messages": {
        "ga_activate": "Creating bank for assigned VRN failed: 'currency_type_id':Please enter correct information!"
    },
    "stat": "Creating bank for assigned VRN failed: 'currency_type_id':Please enter correct information!"
}

{
    "is_successful": false,
    "messages": {
        "data": "No data found.",
        "ga_activate": "Currency 'TFF' is not active and cannot be used for GA activation!"
    },
    "stat": "Currency 'TFF' is not active and cannot be used for GA activation!"
}

{
    "is_successful": false,
    "messages": {
        "ga_activate": "Limit of X hit for currency USD"
    },
    "stat": "Limit of X hit for currency USD"
}

Error Code 536 - Invalid token example

POST Edit Existing Bank Account Details

You edit a bank account name or deactivate an account by sending an HTTP POST request to the /edit_bank endpoint.

You cannot recover or re-use an inactive account. Inactive accounts are removed from all live lists. See View Existing Bank Account Details to view inactive accounts.

Endpoint: /edit_bank

Request Body Payload Example

The request body includes the following parameters:

Example Request

Response Body Payload Example

If the request is successful, the service returns a response.

The response body includes the following parameters:

Example Success Response

If the account is active (active = 1), the response is as follows:

If the account is inactive (active = 0), the response is as follows:

Example Error Responses

If the edit account request is not successful, the service responds with an error code. If the service returns an error, it rejects the request and does not edit the account information. Some examples of error responses are provided.

The JSON structure associated with the error responses has the following parameters:

{
    "is_successful": false,
    "messages": {
        "ga_activate": "Creating bank for assigned VRN failed: 'currency_type_id':Please enter correct information!"
    },
    "stat": "Creating bank for assigned VRN failed: 'currency_type_id':Please enter correct information!"
}

{
    "is_successful": false,
    "messages": {
        "data": "No data found.",
        "ga_activate": "Currency 'TFF' is not active and cannot be used for GA activation!"
    },
    "stat": "Currency 'TFF' is not active and cannot be used for GA activation!"
}

{
    "is_successful": false,
    "messages": {
        "ga_activate": "Limit of X hit for currency USD"
    },
    "stat": "Limit of X hit for currency USD"
}

POST Verify Existing Bank Account Details

You can verify existing bank account details by sending an HTTP POST request to the /verify_bank endpoint.

The request invokes an internal verifier that performs checks on the provided bank account details to ensure conformance to standards.

You must provide a valid value for at least one of the following parameters in the request:

iban (International Bank Account Number) natid (bank number, bank/branch code, sort code, or clearing code of a bank) bic (Bank Information Code) The response always contains a code and a message tag that provide an explanation of the result. For more information, see Bank Verifier Codes and Messages.

Endpoint: /verify_bank

Request Body Payload Example

The request body includes the following parameters:

Example Request

Response Body Payload Example

If the verify account request is successful, the service returns a response.

The response body includes the following parameters:

Example Success Response

Example Error Responses

If the verify account request is not successful, the service responds with an error code. If the service returns an error, it rejects the request and does not edit the account information. Some examples of error responses are provided.

The JSON structure associated with the error responses has the following parameters:

Error Code 534 - specific issue with request, read message for more details

Beneficiary Account Management

A beneficiary account is the destination of a funds transfer. For example, a supplier bank account in an invoice payments system can be a beneficiary account.

Using the Payments API, you can:

• Add a New Beneficiary Account
  A beneficiary bank account must be verified before it is added to the system. The bank verifier provides an indication of possible issues when adding a new beneficiary account.
  The business team adds details, such as payment types (for example, Direct Debit, ACH, or Wire), when the appropriate details are received.

• Add a New Beneficiary Account V2

• Disable an Existing Beneficiary Account

• Edit an Existing Beneficiary Account
  Once a beneficiary account is created, you can edit certain details.
  You can edit the bank address, names associated with the account, and some non-mandatory fields.
  You cannot edit account details such as the account ID or IBAN.

• Edit an Existing Beneficiary Account V2

• View Beneficiary Accounts
  You can get a list of beneficiary accounts filtered by name (a single return) or country (multiple returns).

POST Add a New Beneficiary Account- Scheduled for depreciation 29th September 2025

You add a new beneficiary account by sending an HTTP POST request with the required account information to the /add_beneficiary endpoint.

Endpoint: /add_beneficiary

Request Body Payload Example

The request body includes the following parameters:

Example Request

Response Body Payload Example

If the Add Beneficiary request is successful, the service returns a response.

The response body includes the following parameters:

Example Success Response

Example Error Responses

If the add beneficiary bank account request is not successful, the service responds with an error code, rejects the request, and does not create the new beneficiary account. Some examples of the error responses are provided.

The JSON structure associated with the error responses has the following parameters:

Error Code 521 - Account Number Exists, Client ID Exists, or Unsuccessful Operation

Error Code 522 - One or More JSON Attributes Are Missing or Malformed

Error Code 523 - Invalid Token or Missing Return Data

POST Add a New Beneficiary Account V2

You add a new beneficiary account by sending an HTTP POST request with the required account information to the /v2/add_beneficiary endpoint.

Endpoint: /v2/add_beneficiary

Request Body Payload Example

The request body includes the following parameters:

Example Request

An example of the JSON structure in the request is as follows:

Response Body Payload Example

Example Success Response

The JSON structure in a successful response is as follows:

Example Error Responses

If the /v2/add_beneficiary request is not successful, the service responds with an error code, rejects the request, and does not create the beneficiary. Some examples of error responses are provided. 

The JSON structure associated with the error responses has the following parameters:

Error Code 521

POST Disable an Existing Beneficiary Account

You disable a beneficiary account by sending an HTTP POST request with the required account information to the /disable_beneficiary endpoint.

Endpoint: /disable_beneficiary

Request Body Payload Example

The request body includes the following parameters:

Example Request

Response Body Payload Example

If the disable beneficiary account request is successful, the service returns a response.

The response body includes the following parameters:

Example Success Response

Example Error Responses

If the disable beneficiary bank account request is not successful, the service responds with an error code and rejects the request.

The JSON structure associated with the error responses has the following parameters:

{
    "is_successful": false,
    "messages": {
        "ga_activate": "Creating bank for assigned VRN failed: 'currency_type_id':Please enter correct information!"
    },
    "stat": "Creating bank for assigned VRN failed: 'currency_type_id':Please enter correct information!"
}

{
    "is_successful": false,
    "messages": {
        "data": "No data found.",
        "ga_activate": "Currency 'TFF' is not active and cannot be used for GA activation!"
    },
    "stat": "Currency 'TFF' is not active and cannot be used for GA activation!"
}

{
    "is_successful": false,
    "messages": {
        "ga_activate": "Limit of X hit for currency USD"
    },
    "stat": "Limit of X hit for currency USD"
}

Error Code 400 - Disable not successful

POST Edit an Existing Beneficiary Account- - Scheduled for depreciation 29th September 2025

You edit an existing beneficiary account by sending an HTTP POST request with the required account information to the /edit_beneficiary endpoint.

Certain fields cannot be edited i.e. beneficiary_id.

Note: Some fields cannot be edited after a booking has taken place for the associated beneficiary. These are indicated in the input parameters below with an '*'. E.g client_id.

Endpoint: /edit_beneficiary

Request Body Payload Example

The request body includes the following parameters:

Example Request

Response Body Payload Example

If the Edit Beneficiary request is successful, the service returns a response.

The response body includes the following parameters:

Example Success Response

Example Error Responses

If the edit beneficiary account request is unsuccessful, the service returns a response.

The JSON structure associated with the error responses has the following parameters:

{
    "is_successful": false,
    "messages": {
        "ga_activate": "Creating bank for assigned VRN failed: 'currency_type_id':Please enter correct information!"
    },
    "stat": "Creating bank for assigned VRN failed: 'currency_type_id':Please enter correct information!"
}

{
    "is_successful": false,
    "messages": {
        "data": "No data found.",
        "ga_activate": "Currency 'TFF' is not active and cannot be used for GA activation!"
    },
    "stat": "Currency 'TFF' is not active and cannot be used for GA activation!"
}

{
    "is_successful": false,
    "messages": {
        "ga_activate": "Limit of X hit for currency USD"
    },
    "stat": "Limit of X hit for currency USD"
}

POST Edit an Existing Beneficiary Account V2

You edit an existing beneficiary account by sending an HTTP POST request with the required account information to the /v2/edit_beneficiary endpoint. 

Endpoint: /v2/edit_beneficiary

Request Body Payload Example

The request body includes the following parameters:

Example Request

An example of the JSON structure in the request is as follows:

Response Body Payload Example

If the Edit Beneficiary request is successful, the service returns a response.

The response body includes the following parameters:

Example Success Response

Example Error Responses

If the edit beneficiary account request is unsuccessful, the service returns a response.

The JSON structure associated with the error responses has the following parameters:

{
    "is_successful": false,
    "messages": {
        "ga_activate": "Creating bank for assigned VRN failed: 'currency_type_id':Please enter correct information!"
    },
    "stat": "Creating bank for assigned VRN failed: 'currency_type_id':Please enter correct information!"
}

{
    "is_successful": false,
    "messages": {
        "data": "No data found.",
        "ga_activate": "Currency 'TFF' is not active and cannot be used for GA activation!"
    },
    "stat": "Currency 'TFF' is not active and cannot be used for GA activation!"
}

{
    "is_successful": false,
    "messages": {
        "ga_activate": "Limit of X hit for currency USD"
    },
    "stat": "Limit of X hit for currency USD"
}

POSTView Beneficiary Accounts

You view beneficiary accounts by sending an HTTP POST request with the required account information to the /view_beneficiaries endpoint.

Request Body Payload Example

The request body includes the following parameters:

Example Request

An example of the JSON structure (with Beneficiary Name) in the request is as follows:

An example of the JSON structure (with Beneficiary Id) in the request is as follows:

An example of the JSON structure (with Client ID) in the request is as follows:

An example of the JSON structure (with Beneficiary Email) in the request is as follows:

An example of the JSON structure (with blank beneficiary name and page number) in the request is as follows:

Response Body Payload Example

If the view beneficiary accounts request is successful, the service returns a response.

The response body includes the following parameters:

Example Success Response

Example Error Responses

If the view beneficiary account request is not successful, the service responds with an error code, rejects the request, and does not return the beneficiary account details. An example error response is provided.

The JSON structure associated with the error responses has the following parameters:

Error Code – Invalid Currency

{
    "is_successful": false,
    "messages": {
        "ga_activate": "Creating bank for assigned VRN failed: 'currency_type_id':Please enter correct information!"
    },
    "stat": "Creating bank for assigned VRN failed: 'currency_type_id':Please enter correct information!"
}

Error Code – Currency Not Active

{
    "is_successful": false,
    "messages": {
        "data": "No data found.",
        "ga_activate": "Currency 'TFF' is not active and cannot be used for GA activation!"
    },
    "stat": "Currency 'TFF' is not active and cannot be used for GA activation!"
}

Error Code – Account Limit Reached

{
    "is_successful": false,
    "messages": {
        "ga_activate": "Limit of X hit for currency USD"
    },
    "stat": "Limit of X hit for currency USD"
}

Error Code 500 - Invalid Parameter Format

POSTView Beneficiary Accounts V2

You view beneficiary accounts by sending an HTTP POST request with the required account information to the /v2/view_beneficiaries endpoint.

Endpoint: /v2/view_beneficiaries

Request Body Payload Example

The request body includes the following parameters:

Example Request

An example of the JSON structure (with Beneficiary Name) in the request is as follows:

An example of the JSON structure (with Beneficiary Id) in the request is as follows:

An example of the JSON structure (with Client ID) in the request is as follows:

An example of the JSON structure (with Beneficiary Email) in the request is as follows:

An example of the JSON structure (with blank beneficiary name and page number) in the request is as follows:

Response Body Payload Example

If the view beneficiary accounts request is successful, the service returns a response.

The response body includes the following parameters:

Example Success Response

Example Error Responses

If the view beneficiary account request is not successful, the service responds with an error code, rejects the request, and does not return the beneficiary account details. An example error response is provided.

The JSON structure associated with the error responses has the following parameters:

Error Code – Invalid Currency

{
    "is_successful": false,
    "messages": {
        "ga_activate": "Creating bank for assigned VRN failed: 'currency_type_id':Please enter correct information!"
    },
    "stat": "Creating bank for assigned VRN failed: 'currency_type_id':Please enter correct information!"
}

Error Code – Currency Not Active

{
    "is_successful": false,
    "messages": {
        "data": "No data found.",
        "ga_activate": "Currency 'TFF' is not active and cannot be used for GA activation!"
    },
    "stat": "Currency 'TFF' is not active and cannot be used for GA activation!"
}

Error Code – Account Limit Reached

{
    "is_successful": false,
    "messages": {
        "ga_activate": "Limit of X hit for currency USD"
    },
    "stat": "Limit of X hit for currency USD"
}

Error Code 500 - Invalid Parameter Format

POST Verification Service List

As a response of this endpoint, client will receive a list with all Beneficiary countries, where we provide Beneficiary verification.

Please contact your partner implementation manager at partnerimplementation@transfermate.com if you would like access to this functionality.

Endpoint: /verification_services_list

Example Request

Response Body Payload Example

Example Success Response

POST Verification Service Edit

Using this endpoint, client can activate or disable a beneficiary verification service for a country.

Client can disable/enable more than one country as per endpoint, but they can only do one action- multiple enable or multiple disable.

Endpoint: /verification_services_edit

Request Body Payload Example

Example Request

An example of the JSON structure in the request is as follows:

Response Body Payload Example

Example Success Response

Example Error Responses

HTTP ERROR 522 - Bad request

// Missing active|service_ids param

HTTP ERROR 521 - Bad Request

// Invalid "active" param -> for example "active": "asdasd"

HTTP ERROR 422 - Unprocessable Entity

// Empty "service_ids" provided -> for example "service_ids": []

{
   "is_successful": false,
   "messages": {
      "alert": "For some countries no verification is available for non-local currency bank accounts (i.e. UK accounts where the currency is different from GBP). In case you opt for such verification, TransferMate may not be able to verify the account. Still service charge may apply.",
      "db_action": "Operation is not successful! Please try again."
   },
   "stat": "Please enter only valid service IDs!"
}

// Not existing "service_id" provided -> for example ""

Service cannot be updated ( disabled already or pending activation / deactivation) - message depends on service status

POST Verify Beneficiary

Endpoint: /verify_beneficiary

Request Body Payload Example

The request body includes the following parameters:

Example Request

An example of the JSON structure in the request is as follows:

Response Body Payload Example

The response body includes the following parameters:

Example Success Response

The JSON structure in a successful response is as follows:

Example Error Responses

The JSON structure associated with the error responses has the following parameters.

Treasury Account Management

Treasury Account Management allows you to create, edit and view Global Bank Accounts.

Using the Payments API, you can:

• Activate Virtual/Global Accounts(Scheduled for deprecation)
  You can activate a virtual/global account of a given currency.

• Activate Virtual/Global Accounts V2
  You can activate a virtual/global account of a given currency.

• View Global Bank Accounts
  You can view a list of global accounts. You cannot recover or re-use an inactive account. Inactive accounts are removed from all live lists.

• Edit Global Account Name
  You can edit the name of a Global Account

• View Global Account Details
  You can view the details of a specified global account.

• View Global Account Details V2
  You can view the details of a specified global account.

• View Existing Virtual Bank Account Details
  You can retrieve the details of all existing virtual bank accounts.

• View Virtual Account Details
  You can view the details of a specified virtual account.

• Global Account Summary
  You can retrieve a report on all the active Global accounts and include a .csv and .xls export.

• ASSIGNEE
  You can view the details of a specified virtual account.
  • Add assignee
    You can create and add the details of an assignee to global account.
  • Assign assignee
    You can assign the added assignee to one or more global accounts.
  • View assignee
    You can view all the assignees created under your profile.

POST Activate Virtual/Global Accounts(Scheduled for deprecation)

You can activate virtual and global accounts of a given currency by sending an HTTP POST request to the `/activate_virtual_global_account` endpoint.

Endpoint: /activate_virtual_global_account

Request Body Payload Example

The request body includes the following parameters:

Example Request

Response Body Payload Example

If the activate virtual global account details request is successful, the service returns a response.

The response body includes the following parameters:

Example Success Response

Example Error Responses

{
    "is_successful": false,
    "messages": {
        "ga_activate": "Creating bank for assigned VRN failed: 'currency_type_id':Please enter correct information!"
    },
    "stat": "Creating bank for assigned VRN failed: 'currency_type_id':Please enter correct information!"
}

{
    "is_successful": false,
    "messages": {
        "data": "No data found.",
        "ga_activate": "Currency 'TFF' is not active and cannot be used for GA activation!"
    },
    "stat": "Currency 'TFF' is not active and cannot be used for GA activation!"
}

{
    "is_successful": false,
    "messages": {
        "ga_activate": "Limit of X hit for currency USD"
    },
    "stat": "Limit of X hit for currency USD"
}

POST Activate Virtual/Global Accounts V2

You can activate virtual and global accounts of a given currency by sending an HTTP POST request to the `/activate_virtual_global_account` endpoint.

Endpoint: /v2/activate_virtual_global_account

Request Body Payload Example

The request body includes the following parameters:

Example Request

Response Body Payload Example

If the activate virtual global account details request is successful, the service returns a response.

The response body includes the following parameters:

Example Success Response

Example Error Responses

If the activate virtual global account request is not successful, the service responds with an error code, and rejects the request. Some examples of error responses are provided.

The JSON structure associated with the error responses has the following parameters:

{
    "is_successful": false,
    "messages": {
        "ga_activate": "Creating bank for assigned VRN failed: 'currency_type_id':Please enter correct information!"
    },
    "stat": "Creating bank for assigned VRN failed: 'currency_type_id':Please enter correct information!"
}

{
    "is_successful": false,
    "messages": {
        "data": "No data found.",
        "ga_activate": "Currency 'TFF' is not active and cannot be used for GA activation!"
    },
    "stat": "Currency 'TFF' is not active and cannot be used for GA activation!"
}

{
    "is_successful": false,
    "messages": {
        "ga_activate": "Limit of X hit for currency USD"
    },
    "stat": "Limit of X hit for currency USD"
}

POST View Global Bank Accounts

You can get a list of global bank accounts with details by sending an HTTP POST request to the `/view_banks_global` endpoint.

**NOTE**: View Existing Global Bank Account Details does not have any input parameters.

Endpoint: /view_banks_global

Request Body Payload Example

The request body includes the following parameters:

Example Request

Response Body Payload Example

If the view bank account details request is successful, the service returns a response.

The response body includes the following parameters:

Example Success Response

Example Error Responses

If the add bank request is not successful, the service responds with an error code, rejects the request, and does not create the bank account. Some examples of error responses are provided.

The JSON structure associated with the error responses has the following parameters:

{
    "is_successful": false,
    "messages": {
        "ga_activate": "Creating bank for assigned VRN failed: 'currency_type_id':Please enter correct information!"
    },
    "stat": "Creating bank for assigned VRN failed: 'currency_type_id':Please enter correct information!"
}

{
    "is_successful": false,
    "messages": {
        "data": "No data found.",
        "ga_activate": "Currency 'TFF' is not active and cannot be used for GA activation!"
    },
    "stat": "Currency 'TFF' is not active and cannot be used for GA activation!"
}

{
    "is_successful": false,
    "messages": {
        "ga_activate": "Limit of X hit for currency USD"
    },
    "stat": "Limit of X hit for currency USD"
}

POST View Global Bank Accounts V2

You can get a list of global bank accounts with details by sending an HTTP POST request to the `/v2/view_banks_global` endpoint.

Endpoint: /v2/view_banks_global

Request Body Payload Example

The request body includes the following parameters:

Example Request

Response Body Payload Example

If the request is successful, the response includes the following parameters:

Example Success Response

The JSON structure in a successful response is as follows:

POST View Global Account Details

You can retrieve withdrawals  and deposits from a global account by sending an HTTP POST request to the `/view_global_account_details` endpoint. Recommend to use a date range (Max of 7 days).

Endpoint: /view_global_account_details

Request Body Payload Example

The request body includes the following parameters:

Example Request

Response Body Payload Example

If the view global account details request is successful, the service returns a response.

The response body includes the following parameters:

Example Success Response

Example Error Responses

If the view global bank account details request is not successful, the service responds with an error code, and rejects the request. Some examples of error responses are provided.

The JSON structure associated with the error responses has the following parameters:

Error Code – Invalid Currency

{
    "is_successful": false,
    "messages": {
        "ga_activate": "Creating bank for assigned VRN failed: 'currency_type_id':Please enter correct information!"
    },
    "stat": "Creating bank for assigned VRN failed: 'currency_type_id':Please enter correct information!"
}

Error Code – Currency Not Active

{
    "is_successful": false,
    "messages": {
        "data": "No data found.",
        "ga_activate": "Currency 'TFF' is not active and cannot be used for GA activation!"
    },
    "stat": "Currency 'TFF' is not active and cannot be used for GA activation!"
}

Error Code – Account Limit Reached

{
    "is_successful": false,
    "messages": {
        "ga_activate": "Limit of X hit for currency USD"
    },
    "stat": "Limit of X hit for currency USD"
}

POST View Global Account Details V2

You can retrieve withdrawals  and deposits from a global account by sending an HTTP POST request to the `/v2/view_global_account_details` endpoint. Recommend to use a date range (Max of 7 days)

Endpoint: /v2/view_global_account_details

Request Body Payload Example

The request body includes the following parameters: