Create a draft payment
Before you begin, ensure that you've got an access token. For information about getting the access token, see Tutorial: Create your first draft payment. Then, you can use the /draft_payments endpoint to create a draft payment on behalf of a user, and the draft payment appears in the user account where they can approve or reject.
In addition, you can use this endpoint to make multiple draft payments by creating new rows for new drafts with the supported CSV format shown in the following tables.
For each draft payment request you make, ensure that the same currency is used. Upon a successful request for multiple draft payments, you receive a DraftPaymentID that represents all the draft payments associated with this request.
Please note that the maximum number of rows in a CSV file is 50 and all the payments must be in the same currency.
Download an example CSV file.
Parameters
| NAME | LOCATED IN | DESCRIPTION | REQUIRED |
|---|---|---|---|
scheduledDate | query | The date and time the draft payment is executed. Any draft payment in the CSV file is created as a scheduled payment. | No |
CSV Format
| FIELD | REQUIRED | DESCRIPTION |
|---|---|---|
Name | Yes | Can contain up to 80 characters. If recipient type is INDIVIDUAL, this field must contain a first and a last name, separated by a space. |
Recipient type | Yes | Can be either INDIVIDUAL or COMPANY. |
Account number | For non-IBAN accounts | Must contain a valid account number if provided. |
Sort code or Routing number | For UK/US local transfers | Must contain a valid sort code or routing number if provided. |
IBAN | For IBAN accounts | Must contain a valid IBAN if provided. |
BIC | All the countries except for UK/US local | Must contain a valid BIC if provided. |
Recipient bank country | Yes | Must contain a valid ISO 3166-1 country code. |
Currency | Yes | Must contain a valid ISO 4217 currency code. |
Amount | Yes | Match the pattern: [0-9]*(\\.[0-9]*)? |
Payment reference | Yes | Can contain up to 100 characters. |
Recipient country | No | Must contain a valid ISO 3166-1 country code if provided. |
State or province | No | Can contain up to 50 characters. |
Address line 1 | No | Can contain up to 50 characters. |
Address line 2 | No | Can contain up to 50 characters. |
City | No | Can contain up to 50 characters. |
Postal code | No | Can contain up to 50 characters. |
Request
For the format of the CSV file, check the tables above.
Response
Draft Payment Details