API Reference

Create transfer

post
https://api.mollie.com/v2/business-accounts/transfers

Beta feature

This feature is currently in beta testing, and the final specification may still change.

Create a SEPA Credit Transfer from your Mollie Business Account.

To initiate a transfer, you must provide the transfer scheme, the amount, the debtor IBAN (your Mollie Business Account IBAN), and the creditor (recipient) details.

Each request must include an Idempotency-Key header to prevent duplicate transfers, and must be signed using the X-Client-Signature and X-Client-Signed-At headers.

Simulating transfer scenarios in test mode

In test mode, you can simulate various transfer scenarios by adjusting the transfer amount. This allows you to mimic the typical status progression of a real-world transfer. Note that a transfer's progression will stop once it reaches a final status: blocked, failed, or processed.

AmountScenarioWebhook sequence
11.00Transfer initiated, pending review by Molliebusiness-account-transfer.requested → business-account-transfer.initiated → business-account-transfer.pending-review
12.00Transfer initiated, blocked by Molliebusiness-account-transfer.requested → business-account-transfer.initiated → business-account-transfer.pending-review → business-account-transfer.blocked
13.00Transfer initiated, failed on scheme submissionbusiness-account-transfer.requested → business-account-transfer.initiated → business-account-transfer.failed
OtherDefault: transfer is processedbusiness-account-transfer.requested → business-account-transfer.initiated → business-account-transfer.processed

Access with

Organization access token with business-account-transfers.write

Body Params
string
required

The IBAN of the debtor's (sender) Mollie account from which to initiate the transfer.

creditor
object
required

The creditor (recipient) of the transfer, including their name and account details.

amount
object
required

The amount of the transfer, e.g. {"currency":"EUR", "value":"100.00"} if you would want to transfer €100.00.

Only EUR is supported for SEPA transfers.

string | null

A short description of the transfer. This will appear on the bank statement of both the debtor and creditor.

It must begin with an alphanumeric character, followed by any combination of letters, numbers, spaces or special characters / - ? : ( ) . , ' + _.

Constraints:

  • Cannot be solely a hyphen (-) or colon (:)
  • Cannot contain consecutive hyphens (--)
  • Cannot contain consecutive colons (::)
transferScheme
object
required

The scheme, as requested by the client.

Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.

boolean | null

Whether to create the entity in test mode or live mode.

Most API credentials are specifically created for either live mode or test mode, in which case this parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting testmode to true.

Headers
string
required

A cryptographic signature of the request payload, used to verify the authenticity of the transfer request.

string
required

The timestamp (in ISO 8601 format) indicating when the client signed the request. Used in conjunction with X-Client-Signature for request verification.

string
required

A unique value used to identify this request and prevent duplicate transfers. UUIDv4 is recommended to guarantee uniqueness across multiple processes or servers. If two requests are received with the same idempotency key, the second request will be discarded.

View the public documentation to learn more.

Responses

Updated 20 days ago

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/hal+json

Updated 20 days ago