Update External Transfer

šŸ”’

Required scope: money-movement:write

The API credential calling this endpoint must be granted the money-movement category with read & write access.
Scopes are assigned to the credential when it is created or edited in Pliant, not requested when obtaining the access token.
A credential without this scope receives 403 Forbidden with the error code INSUFFICIENT_PERMISSION.

Update an existing external transfer. You can modify the transfer details including beneficiary, amount, transfer method, and other properties.

Note that transfers can only be modified when they are in DRAFT status. Once submitted for processing, most fields become read-only.

Path Params
uuid
required

The unique identifier of the external transfer.

Body Params
uuid
required

The beneficiary who will receive the transfer.

uuid
required

The payment details for the beneficiary. Must belong to the beneficiary identified by beneficiaryId; otherwise the request is rejected with a 400 Bad Request and the error code BENEFICIARY_VALIDATION_FAILED.

uuid

The card account from which the transfer will be made. Optional, a draft may leave this unset. If provided, it must belong to the transfer's organization, otherwise the request is rejected with a 404 Not Found and the error code NOT_FOUND.

transferAmount
object
required

The amount of the transfer. Must be strictly positive.

string
enum

The transfer method for the external transfer. Whether it is required depends on the transfer currency:

  • SEPA_CREDIT_TRANSFER: SEPA Standard Credit Transfer (SCT). Required for EUR transfers.
  • INSTANT_CREDIT_TRANSFER: Instant payment. SEPA Instant for SEK and DKK transfers, UK Faster Payments for GBP transfers to UK local accounts (account number and sort code). Required for these transfers.

For all other supported currencies (AED, CZK, HUF, NOK, PLN, RON, USD, and GBP transfers to IBAN accounts) this field must be omitted — the rail is selected automatically and sending a value is rejected.

Allowed:
string

The purpose or description of the transfer.

string

The invoice number associated with the transfer.

date

The date of the invoice.

date

The due date for the transfer.

date-time

The scheduled time for the transfer.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json