Create transfer

Creates a transfer from a client's account. The type field selects the kind of transfer:

outgoing - a payment to a beneficiary over the selected paymentMethod; amount is in the currency of
the sending account. Up to 4 uploaded documents can be attached by their stored file names (documents).

exchange - a currency exchange between two accounts of the same client; sellAmount is debited from the
sell account.

The response contains the transfer identifier; the transfer starts in the processing state. The outcome is
reported asynchronously with the outgoingTransferExecuted / outgoingTransferCancelled or
exchangeTransferExecuted / exchangeTransferCancelled webhooks; you can also poll GET /baas/Transfers/{id}.

externalId is your identifier of the transfer and protects against duplicates: while a transfer with the
same externalId is processing or completed, a new request returns 409 Conflict. After a failed transfer,
the same externalId can be used 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; 422 Unprocessable Content if the transfer cannot be
created for any other reason, for example when an account is not found.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/json

Example

{
    "externalId": "string",
    "type": "outgoing",
    "paymentMethod": "sepa",
    "reference": "string",
    "purpose": "string",
    "purposes": {
        "property1": "string",
        "property2": "string"
    },
    "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
    "amount": 1,
    "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