Payment drafts

Update a payment in a payment draft

Update the fields of a single payment within a payment draft.

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

All fields are optional — omit what should not change. Other payments in the draft are unaffected.

For more information, see the guides: Payment drafts.

patch/payment-drafts/{payment_draft_id}/payments/{payment_id}

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 that contains the payment.

payment_idstring uuid required

The ID of the payment to update.

Request body

amountnumber double

The amount of the payment.

currencystring

ISO 4217 currency code in upper case.

referencestring

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.

charge_bearer'shared' | 'debtor' nullable

The party that should bear the transaction fees related to the selected transaction route if applied.

ValueDescription
sharedAlso known as SHA. The transaction route fees are split between the sender and the recipient.
debtorAlso known as OUR. The sender pays all explicit transaction fees.
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 payment was successfully updated

Changes

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