Guides

International Bank

Suggest Edits

International Bank transfers allow for secure cross-border payments directly to beneficiaries' bank accounts in various countries. This method supports multiple currencies and is suitable for global transactions, though processing times can vary depending on the destination country and bank.

The usual workflow for integrating with the non-hosted solution involves the following steps:

Step 1: Authenticate: Obtain an API token by validating your credentials.

Step 2: Create Beneficiary: Create and manage beneficiary's accounts using API calls.

Step 3: Create Transfer Method: Add and manage transfer methods for your beneficiaries.

Step 4: Create Transfer: Execute and manage transfers between accounts.

API Endpoints Used

This guide will demonstrate step-by-step instructions using the API integration method. In this guide, you will use the following API endpoints:

Get API Token

Create Beneficiary

Add Bank Account

Create Transfer

Below, you will go through the necessary API calls to achieve the steps above within the i-payout system.

📘

Recipe

You can also follow our recipe by clicking the link below:

🦉
International Bank Payout
Open Recipe

Step 1: Authenticate

To start using i-payout solutions, you will need to authenticate with your API Token. Refer to the Get a Token guide to learn how to:

Obtain a Token through the API

Obtain a Token through the i-payout Admin Portal

Use your API Token

Step 2: Create Beneficiary

A beneficiary is an individual designated to receive funds or payments through the i-payout system. To create a beneficiary, you will need to provide detailed information about the individual, such as their name, address, and payment details.

Use the Create Beneficiary endpoint to create a new beneficiary. The request should include all necessary details about the beneficiary in the request body and, as shown in Step 1, include the authentication to access the i-payout API. Below, you will find an example request to create a new beneficiary:

curl --request POST \
     --url "https://merchantapi.testewallet.com/api/v1/beneficiaries" \
     --header 'Authorization: Bearer <YOUR_API_TOKEN>' \
     --header 'X-MerchantId: <YOUR_MERCHANT_ID>' \
     --header 'accept: application/json' \
     --header 'content-type: application/*+json' \
     --data '{
        "username": "john_doe",
        "firstName": "John",
        "lastName": "Doe",
        "emailAddress": "[email protected]"
    }'

{
  "data": {
    "customerToken": "e0e4764b-9619-4deb-95c4-108ce9f0fe04"
  },
  "isSuccess": true,
  "message": "Customer created successfully",
  "statusCode": 0,
  "logIdentifier": "497b73624c0d47bfb0abf58df5dd99ca"
}

Step 3: Create Transfer Method

To manage how funds are transferred to beneficiaries, you need to create a transfer method. To add an international bank account transfer method, use the Add Bank Account endpoint. This lets you specify the beneficiary's bank account details, ensuring funds are correctly directed to their bank account. Below, you will find an example request to add a bank account:

curl --request POST \
     --url "https://merchantapi.testewallet.com/api/v1/transfermethods/beneficiaries/<BENEFICIARY_TOKEN_FROM_STEP_2>/bank-accounts" \
     --header 'Authorization: Bearer <YOUR_API_TOKEN>' \
     --header 'X-MerchantId: <YOUR_MERCHANT_ID>' \
     --header 'accept: application/json' \
     --header 'content-type: application/*+json' \
     --data '{
         "beneficiaryToken": "<beneficiaryToken_from_step_2>",
         "accountHolderName": "John Doe",
         "accountNickName": "John UK Account",
         "accountCurrency": "GBP",
         "accountNumber": "987654321",
         "accountType1": "personal",  # can be either 'personal' or 'business'
         "accountType2": "checking",  # can be either 'checking' or 'savings'
         "bankName": "HSBC",
         "bankCode": "HSBC123",  # UK bank code if applicable, or null
         "bankCountry": "GB",
         "swiftCode": "HBUKGB4B",
         "routingNumber": "40-30-20",
         "branchAddress": "1 Queens Road, Central London",
         "beneficiaryFirstName": "John",
         "beneficiaryLastName": "Doe",
         "beneficiaryCountry": "GB",
         "beneficiaryAddress1": "123 King St",
         "beneficiaryState": "England",
         "beneficiaryCity": "London",
         "beneficiaryZipCode": "SW1A 1AA",
     }'

{
  "isSuccess": true,
  "message": "Bank account added successfully",
  "statusCode": 200,
  "logIdentifier": "def456ghi789",
  "token": "bankAcc123Token",
  "dateCreated": "2024-07-20T10:00:00.000Z",
  "dateUpdated": "2024-07-20T10:00:00.000Z"
}

Step 4: Create Transfer

With the new beneficiaries created in the system, you can now pay them. This is done by transferring funds to them. The Create Transfer endpoint will be used to make the transfer from you to your beneficiary by linking the transfer with the beneficiaryToken created on Step 2. Below, you will find an example request to create a new transfer:

curl --request POST \
     --url "https://merchantapi.testewallet.com/api/v1/transfers" \
     --header 'Authorization: Bearer <YOUR_API_TOKEN>' \
     --header 'X-MerchantId: <YOUR_MERCHANT_ID>' \
     --header "accept: application/json" \
     --header "Content-Type: application/json" \
     --data '{
         "merchantTransactionId": "TX123456",
         "beneficiaryToken": "<beneficiaryToken_from_step_2>",
         "autoApprove": True,
         "comments": "Payment for services",
         "dateExpire": "2024-12-31T23:59:59.999Z",
         "destinationAmount": 100.00,
         "destinationCurrency": "GBP",
         "destinationType": "Bank",
         "bankAccount": {
             "accountNickName": "Johns UK Account",
             "accountCurrency": "GBP",
             "accountNumber": "987654321",
             "accountType1": "personal",
             "accountType2": "checking",
             "bankName": "HSBC",
             "bankCountry": "GB",
             "routingNumber": "40-30-20",
             "branchAddress": "1 Queens Road, Central London",
             "beneficiaryFirstName": "John",
             "beneficiaryLastName": "Doe",
             "beneficiaryDateOfBirth": "1990-01-01",
             "beneficiaryGovernmentID": "987654321",
             "beneficiaryCountry": "GB",
             "beneficiaryAddress1": "123 King St",
             "beneficiaryState": "England",
             "beneficiaryCity": "London",
             "beneficiaryZipCode": "SW1A 1AA",
         },
     }'

{
  "isSuccess": true,
  "message": "Transfer created successfully",
  "statusCode": 200,
  "logIdentifier": "abc123def456",
  "token": "trans789token",
  "dateCreated": "2024-07-09T16:17:00.548Z",
  "dateUpdated": "2024-07-09T16:17:00.548Z",
  "statusId": 1,
  "fxRate": 1.05,
  "customerFee": 2.50,
  "merchantFee": 1.00
}

Other Available Payout Methods

Follow the links below to learn more about other available payout methods:

Updated 24 days ago