Create External Transfer

post

https://partner-api.getpliant.com/api/external-transfers

Create a new external transfer for the specified organization.

External transfers are payments made to beneficiaries outside of your organization. You must provide the beneficiary information, transfer amount, and transfer method. The transfer will initially be created in DRAFT status and can be modified until submitted for processing.

Body Params

organizationId

uuid

required

The organization for which the external transfer is being created.

teamId

uuid

The team associated with the external transfer.

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_CREDIT_TRANSFER: SEPA Standard Credit Transfer (SCT). Used for EUR transfers, and is the default transfer method for EUR.
INSTANT_CREDIT_TRANSFER: SEPA Instant Credit Transfer. Available for DKK and SEK transfers; not available for EUR.

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.

vopId

uuid

The unique identifier of a completed Verification of Payee (VoP) check. Required for SEPA_CREDIT_TRANSFER transfers in accordance with the Verification of Payee regulation.

Obtain this value by calling POST /vop/verification before creating the transfer. The verification must have status: ACTIVE (valid for 60 minutes after creation).

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

201Created

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.

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.