GEgetpliant
External Transfers

Create External Transfer

Changed on

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.

post/external-transfers

Request

Request body

organizationIdstring uuid required

The organization for which the external transfer is being created.

teamIdstring uuid

The team associated with the external transfer.

beneficiaryIdstring uuid required

The beneficiary who will receive the transfer.

beneficiaryPaymentDetailIdstring uuid

The payment details for the beneficiary.

sourceCardAccountIdstring uuid

The card account from which the transfer will be made.

transferMethod'SEPA_CREDIT_TRANSFER' | 'INSTANT_CREDIT_TRANSFER'

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.

purposestring

The purpose or description of the transfer.

invoiceNumberstring

The invoice number associated with the transfer.

invoiceDatestring date

The date of the invoice.

dueDatestring date

The due date for the transfer.

transferTimestring date-time

The scheduled time for the transfer.

vopIdstring 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).

Response

Created

idstring uuid

The unique identifier of the external transfer.

organizationIdstring uuid

The organization to which the external transfer belongs.

teamIdstring uuid

The team associated with the external transfer.

memberIdstring uuid

The member who created the external transfer.

beneficiaryIdstring uuid

The beneficiary who will receive the transfer.

beneficiaryPaymentDetailIdstring uuid

The payment details for the beneficiary.

sourceCardAccountIdstring uuid

The card account from which the transfer will be made.

transferMethod'SEPA_CREDIT_TRANSFER' | 'INSTANT_CREDIT_TRANSFER'

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

  • SEPA_CREDIT_TRANSFER: Used for EUR transfers.
  • INSTANT_CREDIT_TRANSFER: Used for SEK and DKK transfers, and for GBP transfers to UK local accounts (UK Faster Payments).

For all other supported currencies (AED, CZK, HUF, NOK, PLN, RON, USD, and GBP transfers to IBAN accounts) this field is not set (null / omitted) because the rail is selected automatically.

status'DRAFT' | 'NEEDS_APPROVAL' | 'APPROVED' | 'COMPLIANCE_CHECK' | 'COMPLIANCE_PASSED' | 'COMPLIANCE_REVIEW' | 'PAYMENT_IN_PROGRESS' | 'PAID' | 'FAILED'

The current status of the external transfer. It can be one of the following values:

  • DRAFT: Transfer is in draft state and can be modified
  • NEEDS_APPROVAL: Transfer requires approval before processing
  • APPROVED: Transfer has been approved and is ready for processing
  • COMPLIANCE_CHECK: Transfer is undergoing compliance checks
  • COMPLIANCE_PASSED: Transfer has passed compliance checks
  • COMPLIANCE_REVIEW: Transfer is under compliance review
  • PAYMENT_IN_PROGRESS: Transfer is currently being processed
  • PAID: Transfer has been successfully completed
  • FAILED: Transfer has failed
purposestring

The purpose or description of the transfer.

invoiceNumberstring

The invoice number associated with the transfer.

invoiceDatestring date

The date of the invoice.

dueDatestring date

The due date for the transfer.

transferTimestring date-time

The scheduled time for the transfer.

approvedAtstring date-time

The date and time when the transfer was approved.

createdAtstring date-time

The date and time when the transfer was created.

Changes