Business API
Get transfer reasons
api
get
/transfer-reasons

Get transfer reasons

In order to initiate a transfer in certain currencies and countries, you must provide a transfer reason. With this endpoint you can retrieve all transfer reasons available to your business account per country and currency.

After you retrieve the results, use the appropriate reason code in the transfer_reason_code field when creating a payment to a counterparty or creating a payout link.

Access Token

Each Business API request must contain an authorization header in the following format to make a call: Bearer <your_access_token>.

The access token will be obtained the first time you set up your application and has an expiration of 40 minutes. During setup, a refresh_token will also be obtained which allows to obtain a new access_token.

danger

Never share your client-assertion JWT (JSON web token), access_token and refresh_token with anyone, as these can be used to access your banking data and initiate transactions.

Access tokens can be issued with four security scopes and require a JWT (JSON Web Token) signature to be obtained:

  • READ: Permissions for GET operations.

  • WRITE: Permissions to update counterparties, webhooks, and issue payment drafts.

  • PAY: Permissions to initiate or cancel transactions and currency exchanges.

  • READ_SENSITIVE_CARD_DATA: Permissions to retrieve sensitive card details.

    caution

    If you enable the READ_SENSITIVE_CARD_DATA scope for your access token, you must set up IP whitelisting. Failing to do so will prevent you from accessing any Business API endpoint.

    IP whitelisting means that you must specify an IP or a set of IPs which will be the only IPs from which requests to the API will be accepted. To do so:

    1. In the Revolut Business app, select the corresponding API certificate.
    2. In Production IP whitelist, provide the IP(s) which should be whitelisted, and save.

To configure your JWT and obtain the refresh and first access tokens, complete the following steps:

  1. Sign up for a Revolut Business account
  2. Prepare your Sandbox environment
  3. Make your first API request

Response

List of transfer reasons

Response body
Body array

Possible values: Value must match regular expression ^[A-Z]{2,3}$

The bank country of the counterparty as the 2-letter ISO 3166 code.

Possible values: Value must match regular expression ^[A-Z]{3}$

ISO 4217 currency code in upper case.

Possible values: [advertising, advisor_fees, business_insurance, construction, delivery, education, family, fund_investment, goods, homesend, hotel, exports, insurance_claims, insurance_premium, loan_repayment, medical, office, other_fees, personal_transfer, property_purchase, property_rental, royalties, services, share_investment, tax, transfer, transportation, travel, utilities]

Category name of the transfer reason.

The description of the given transfer reason.

Was this page helpful?
Loading...