Payment drafts

Add a payment to a payment draft

Add a new payment to an existing payment draft.

:::note You can add payments to drafts created with the API or via the Revolut Business app. :::

The payment uses the same shape as the payments in the create payment draft request.

For more information, see the guides: Payment drafts.

post/payment-drafts/{payment_draft_id}/payments

Request

  • Base URL
    https://b2b.revolut.com/api/1.0
  • Auth
    HTTP bearer

Path parameters

payment_draft_idstring uuid required

The ID of the payment draft to add the payment to.

Request body

account_idstring uuid required

The ID of the account to pay from.

:::note You can specify only one account ID for multiple payments in the same payment draft. :::

amountnumber double required

The amount of the payment.

currencystring required

ISO 4217 currency code in upper case.

referencestring required

The reference for the payment. A piece of text or number you provide to help identify what the payment relates to. It can be used, for example, for reconciliation or tracking purposes.

You might include an invoice number, account or transaction ID, or any other reference meaningful to you.

charge_bearer'shared' | 'debtor'

The party that should bear the transaction fees related to the selected transaction route if applied. Possible options are:

ValueDescription
sharedAlso known as SHA. The transaction route fees are split between the sender and the recipient. The sender pays the fees charged by their bank, while the recipient pays the fees charged by the receiving and any intermediary banks.
debtorAlso known as OUR. The sender pays all explicit transaction fees.

:::note

  • This field is not supported for bulk payments.
  • Some transactions with fees might not support charge bearer selection. If this is the case, the request will return an error. To proceed with the default fee handling, remove this field from your request and try again. :::
transfer_reason_codestring

The reason code for the transaction. Transactions to certain countries and currencies might require you to provide a transfer reason. You can check available reason codes with the GET /transfer-reasons operation.

If a transfer reason is not required for the given currency and country, this field is ignored.

Example request

{
  "transfer_reason_code": "property_rental"
}

Response

The ID of the payment that was added to the draft

idstring uuid required

The ID of the payment added to the draft.

Changes

No recorded changes to this operation across all 1 revision of this API.