Update External Transfer

put

https://partner-api.getpliant.com/api/external-transfers/{externalTransferId}

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

externalTransferId

uuid

required

The unique identifier of the external transfer.

Body Params

beneficiaryId

uuid

required

The beneficiary who will receive the transfer.

beneficiaryPaymentDetailId

uuid

The payment details for the beneficiary.

sourceCardAccountId

uuid

The card account from which the transfer will be made.

transferAmount

object

The amount of the transfer.

transferMethod

string

enum

The transfer method used for the external transfer. It can be one of the following values:

SEPA: Single Euro Payments Area transfer
SEPAINST: SEPA Instant transfer

Allowed:

purpose

string

The purpose or description of the transfer.

invoiceNumber

string

The invoice number associated with the transfer.

invoiceDate

date

The date of the invoice.

dueDate

date

The due date for the transfer.

transferTime

date-time

The scheduled time for the transfer.

Responses

Language

Credentials

Bearer

JWT

URL

Response

Choose an example:

application/json

200Ok

400Bad Request. The API consumer sent a malformed request which could not be processed.

401Unauthorized. The API consumer is not authorized to access the requested resource.

403Forbidden. The API consumer is not allowed to access the requested resource.

404Not Found. The requested resource could not be found.

409Conflict. The request could not be completed due to a conflict with the current state of the resource. You may retry the call.

429Too Many Requests. The API consumer has sent too many requests in a given amount of time. Please check our API guidelines.

500Internal Server Error. The request was not completed due to an internal error.