Skip to main content

​
Overview

Link an international bank account to enable cross-border wire transfers and international payouts. This endpoint allows you to connect a customer’s international bank account as a payout destination.

​
Prerequisites

  • An application token (obtained from creating a payout link or account widget)
  • Valid access token

​
Endpoint

  • POST {{LIQUIDITY_URL}}/v1/ext/application-token/:token/linked-accounts/:currency/link/international_bank/:step
  • Auth: Bearer {{accessToken}}

​
Path Parameters

ParameterTypeDescriptionRequired
tokenstringApplication token from payout/account widgetYes
currencystringCurrency code (e.g., USD)Yes
stepstringUsually 1Yes

​
Request

curl -X POST "{{LIQUIDITY_URL}}/v1/ext/application-token/{{token}}/linked-accounts/USD/link/international_bank/1" \
  -H "Authorization: Bearer {{accessToken}}" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "My UK Business Account",
    "data": {
      "firstName": "John",
      "lastName": "Doe",
      "name": "Quantum Works LLC",
      "accountNumber": "8991026399",
      "swiftOrBic": "031000053",
      "bankName": "ABC bank",
      "recipientAddress": "9401 San francisco",
      "recipientCity": "San francisco",
      "recipientState": "CA",
      "recipientPostalCode": "9401",
      "email": "timi@gradientfi.com",
      "recipientCountry": "NG",
      "recipientType": "personal"
    }
  }'

​
Request Body Fields

FieldTypeDescriptionRequired
labelstringDisplay name for the linked accountYes
data.firstNamestringFirst name of recipientYes
data.lastNamestringLast name of recipientYes
data.namestringBusiness/account nameYes
data.accountNumberstringInternational bank account numberYes
data.swiftOrBicstringSWIFT/BIC codeYes
data.bankNamestringName of the international bankYes
data.recipientAddressstringFull address of the recipientYes
data.recipientCitystringCity of the recipientYes
data.recipientStatestringState/region of the recipientYes
data.recipientPostalCodestringPostal code of the recipientYes
data.emailstringEmail of the recipientYes
data.recipientCountrystringISO country code (2 letters, e.g., NG)Yes
data.recipientTypestringRecipient type: personal or businessYes

​
Response (200)

{
  "data": {
    "type": "completed",
    "message": "Account successfully linked!",
    "data": {
      "id": "119d213c-65a9-4485-b2bc-14c6dc5a3fb1",
      "currency": "USD",
      "optionType": "international_bank",
      "account": {
        "label": "My UK Business Account",
        "lastFourDigits": "5678"
      },
      "wallet": {
        "id": "3eb8d02c-30e0-497c-a6ac-e2d203c63198",
        "balance": "99811.95",
        "disabled": false
      },
      "entity": {
        "id": "d5e6f1dd-57bc-4581-98e8-646264a5f2c9",
        "entityType": "BUSINESS"
      }
    }
  }
}

​
Response Fields

FieldTypeDescription
data.data.idstringLinked account ID (use for withdrawals)
data.data.currencystringCurrency of the linked account
data.data.optionTypestringAccount type: international_bank
data.data.account.labelstringDisplay label for the account
data.data.account.lastFourDigitsstringLast 4 digits of account number
data.data.wallet.idstringAssociated wallet ID
data.data.wallet.balancestringCurrent wallet balance
data.data.entity.idstringEntity ID associated with the account
data.data.entity.entityTypestringEntity type: USER or BUSINESS

​
Notes

  • Store the id from the response for use in withdrawal requests
  • Provide accurate recipient address/country data for compliance
  • SWIFT/BIC should match the destination bank
  • International wire transfers may have higher fees and longer processing times
  • The linked account can be used for withdrawals once successfully created