Recipient Data Details in API Transaction

Modified on Mon, 21 Aug, 2023 at 3:34 AM

Learn the necessary recipient data in API transactions, including names and account numbers for local transfers, and additional details for international transfers.

Table of Contents

Efficient and accurate handling of recipient data is crucial for seamless API transactions. Whether you're conducting local transfers or international transfers, understanding the specific recipient data requirements is essential. This article provides valuable insights into the recipient data needed for API local transfers and dives into specific fields required for API international transfers. By familiarizing yourself with these details, you can ensure smooth and error-free transaction processing.

Recipient Data for Local API Transaction

When initiating local transfers through API, it is essential to provide accurate recipient data, including the recipient's name (first name and last name) and account number. Ensuring the recipient's name is not empty and contains alphabetic characters is important for seamless identification and crediting of their bank account within the same country. For the account number, it should be a 6-20 digit numerical value. We highly recommend validating your recipient's bank account number before creating a transaction. For more information on how to validate the account, please refer to this article.

Recipient Data for International API Transaction

International transfers introduce many beneficiary data requirements across different countries. To gain a comprehensive understanding of the specific fields required by each country, you can leverage designated API endpoints, such as this endpoint, which provide detailed information. This article focuses on explaining key fields commonly needed for international transactions.

BSB Number

The BSB (Bank-State-Branch) Number is a six-digit code used in Australia to identify a specific bank branch. It is typically needed for transfers within Australia.

ABA Routing Number

The ABA (American Bankers Association) Routing Number is a nine-digit code used in the United States to identify financial institutions. It is essential for domestic transfers within the U.S.

IBAN (International Bank Account Number)

The IBAN is an internationally recognized standard for identifying bank accounts. It consists of a country code, check digits, and a bank account number. IBANs are commonly used in European countries and other parts of the world for international transfers.


The SWIFT BIC (Society for Worldwide Interbank Financial Telecommunication Business Identifier Code) is a unique identification code used to identify financial institutions globally. It contains either eight or eleven alphanumeric characters and is primarily used for international transfers.

Sort Code

The Sort Code is a six-digit number used in the United Kingdom and Ireland to identify the bank and branch where an account is held. It is important for domestic transfers within these countries.

Mastering the requirements for recipient data in API transactions is crucial for ensuring smooth and secure fund transfers. In local transfers, it is essential to provide the recipient's name (first name and last name) and account number. Additionally, international transfers may require additional fields such as the BSB Number, ABA Routing Number, IBAN, SWIFT BIC, or Sort code, depending on the recipient's country. By understanding and providing accurate recipient data, you can enhance the efficiency and reliability of your API transfers, facilitating seamless financial connectivity across borders. If you require assistance or have any questions, please don't hesitate to contact us for personalized support.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article