Create transfer

Creates a transfer from one of your organization's accounts. The type field selects the kind of transfer:

outgoing - a payment to a beneficiary over the selected paymentMethod. amount is in the account
currency, and the amount plus fee must be covered by the account balance. Up to 4 uploaded documents can be
attached by their stored file names (documents).

exchange - a currency exchange between two of your accounts in different currencies; sellAmount is
debited from the sell account.

The response contains the transfer identifier. The transfer is processed asynchronously, and the outcome is
reported with the outgoingTransferExecuted / outgoingTransferCancelled or exchangeTransferExecuted /
exchangeTransferCancelled webhooks; you can also poll GET /integration/transfers/{id}.

The request is not idempotent: every successful call creates a new transfer. If a call fails with a timeout,
check GET /integration/transfers before sending it again.

purpose and purposes are different fields: purpose is a free-text description of the payment, and
purposes holds coded attributes, such as a purpose code, that some payment methods require.

Errors: 400 Bad Request for invalid request data, including an insufficient balance;
422 Unprocessable Content if the transfer cannot be created for any other reason, for example when the
account is not available.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/json

Example

{
    "type": "outgoing",
    "paymentMethod": "sepa",
    "reference": "string",
    "purpose": "string",
    "purposes": {
        "property1": "string",
        "property2": "string"
    },
    "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
    "amount": 0,
    "beneficiary": {
        "credentials": {
            "bankDetails": {
                "bankName": "string",
                "bankCountry": "string",
                "bankRegion": "string",
                "bankAddress": "string",
                "bic": "string",
                "intermediaryBic": "string",
                "bankCode": "string",
                "routingNumber": "string",
                "sortCode": "string",
                "branchCode": "string"
            },
            "type": "sepa",
            "iban": "string",
            "reference": "string"
        },
        "legalEntity": {
            "address": {
                "streetLine1": "string",
                "streetLine2": "string",
                "city": "string",
                "state": "string",
                "zip": "string",
                "country": "string"
            },
            "type": "business",
            "legalName": "string"
        }
    },
    "documents": [
        "string"
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Request

Request Code Samples

Responses