Work with draft payments

Review the important considerations when you build your draft payments integration.

International payments​

In the CSV file that you upload to create draft payments, the following fields and multiple address fields are provided for draft payments made to bank accounts across the globe.

• Account Number
• Sort Code or Routing Number
• IBAN
• BIC
• Currency
• Country

For each draft payment, the following fields are required:

• Name
• Recipient type
• Recipient bank country
• Currency
• Amount
• Payment reference

However, depending on the currency and the country of the bank account, some fields are also required for a draft payment in the CSV file, which is shown in the following table:

See the following lists for IBAN/SEPA countries and currencies supported.

Account selection​

In Revolut Business, an account can have multiple pockets in different currencies.

The pocket selected for a draft payment is the pocket with the highest amount of currency that matches the currency of the payment.

If no pocket matches the currency of the payment, the pocket with the default currency of the account is chosen and there is an automatic currency conversion while the payment is being executed.

CSV validation​

CSV with errors:

Name,Recipient type,Account number,Sort code or Routing number,IBAN,BIC,Recipient bank country,Currency,Amount,Payment reference,Recipient country,State or province,Address line 1,Address line 2,City,Postal code
Dmitry Vim,INDIVIDUAL,40513598,207409,,,GB,GBP,10,Comment Comment Comment Comment Comment Comment Comment Comment Comment Comment Comment Comment Comment Comment,GB,,Revolutest LTD, Level 39,Somewhere in London,E14 5AB
Dmitry Vim,INDIVIDUAL,40513598,207409,,,GB,abc,25,Second comment,uk,,Revolutest LTD, Level 39,Somewhere in London,E14 5AB
,INDIVIDUAL,,,,,GB,GBP,25,Second comment,GB,,Revolutest LTD Level 39,Somewhere in London,Taumatawhakatangihangakoauauotamateaturipukakapikimaungahoronukupokaiwhenuakitanatahu,E14 5AB
Dmitry Vim,INDIVIDUAL,776644,,,BOFMHKHH,CN,USD,10,User comment,CN,,1 Yuan,,Beijing City,100046
Dmitry Vim,,40513598,207409,,,GB,GBP,0.10,User comment,GB,,Revolutest LTD, Level 39,Somewhere in London,E14 5AB
Dmitry Vim,INDIVIDUA,40513598,207409,,,GB,GBP,10,User comment,GB,,Revolutest LTD, Level 39,Somewhere in London,E14 5AB
Dmitry Vim,INDIVIDUAL,ÓŁ,2409,1234,ABC,GB,GBP,10,User comment,GB,,Revolutest LTD, Level 39,Somewhere in London,E14 5AB
DmitryVim,INDIVIDUAL,40513598,207409,,,GB,GBP,10,User comment,GB,,,Somewhere in London,123
Dmitry Vim,INDIVIDUAL,40513598,207409,,,GB,GBP,10,User comment,GB,,Revolutest LTD, Level 39,Somewhere in London,123

Response:

{
  "Id": "a3805a6c-ae21-4871-b9a3-2c2c9db60ffa",
  "Message": "File validation failed",
  "Errors": [{
    "Row": 2,
    "Errors": [{
      "Field": "Payment reference",
      "Code": 2003,
      "Message": "Payment reference cannot be longer than 100 symbols"
    }]
  }, {
    "Row": 3,
    "Errors": [{
      "Field": "Currency",
      "Code": 2004,
      "Message": "Invalid Currency: abc"
    }, {
      "Field": "Recipient country",
      "Code": 2004,
      "Message": "Invalid Recipient country: uk"
    }]
  }, {
    "Row": 4,
    "Errors": [{
      "Field": "Name",
      "Code": 2001,
      "Message": "Name is required"
    }, {
      "Field": "City",
      "Code": 2003,
      "Message": "City cannot be longer than 50 symbols"
    }]
  }, {
    "Row": 5,
    "Errors": [{
      "Code": 2008,
      "Message": "Invalid BIC for CN bank country"
    }]
  }, {
    "Row": 6,
    "Errors": [{
      "Field": "Recipient type",
      "Code": 2001,
      "Message": "Recipient type is required"
    }]
  }, {
    "Row": 7,
    "Errors": [{
      "Field": "Recipient type",
      "Code": 2004,
      "Message": "Invalid Recipient type: INDIVIDUA"
    }]
  }, {
    "Row": 8,
    "Errors": [{
      "Field": "Account number",
      "Code": 2004,
      "Message": "Invalid Account number: �?"
    }, {
      "Field": "Sort code or Routing number",
      "Code": 2004,
      "Message": "Invalid Sort code or Routing number: 2409"
    }, {
      "Field": "IBAN",
      "Code": 2004,
      "Message": "Invalid IBAN: 1234"
    }, {
      "Field": "BIC",
      "Code": 2004,
      "Message": "Invalid BIC: ABC"
    }]
  }, {
    "Row": 9,
    "Errors": [{
      "Field": "Name",
      "Code": 2005,
      "Message": "First and last name are required for individuals"
    }]
  }, {
    "Row": 10,
    "Errors": [{
      "Code": 2008,
      "Message": "Postcode 123 is invalid, please change it before continuing"
    }]
  }],
  "Code": 3039
}

We validate if the fields in the CSV match the format required and if the bank account details provided are valid for a payment to be made.

If there is an issue with the CSV uploaded, the API responds with a 3039 error code and give details of the CSV validation errors row by row. Each error message is accompanied by a corresponding code.

In addition, with the exception of error codes 2008 and 1000, we will also pass the relevant Field that causes the validation to fail.

Error codes​

Check the example file above and the response with relevant errors.

HTTP error codes for draft payments​

Check the following table to understand the error messages for draft payments:

Payment orders vs transfers​

When you create a bulk draft payment, it consists of a draft payment order, which in turn contains a set of transfers.

Both a draft payment order and transfers have own independent states.

Draft payment order​

A draft payment order is what the user either approves or deletes from the user interface. It can have the following possible states:

Transfers​

When the user approves a draft payment order, each transfer is executed individually. Each transfer can have the following possible states:

Failure codes​

There are a number of different reasons that transfers can fail.

Check the following table about different values of FailedReasonCode:

Each FailedReasonCode is accompanied by a custom FailedReasonMessage to give detail on the failure.