MOmollie
Transfers API

Get transfer

Changed on

🚧 Beta feature

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

Retrieve a single transfer object by its transfer ID. This allows you to check the current status and details of a previously created transfer.

get/v2/business-accounts/transfers/{businessAccountsTransferId}

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/business-accounts/transfers/{businessAccountsTransferId}
  • Auth
    HTTP bearer

Query parameters

testmodeboolean

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

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Response

The transfer object.

resourcestring

Indicates the response contains a transfer object. Will always contain the string business-account-transfer for this endpoint.

idstring
mode'live' | 'test'

Whether this entity was created in live mode or in test mode.

debtorIbanstring

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

descriptionstring nullable

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 (::)
businessAccountTransactionIdstring
creditDebitIndicator'credit' | 'debit'

Indicates whether the entry is a credit or debit from the perspective of the account holder.

status'requested' | 'initiated' | 'pending-review' | 'processed' | 'failed' | 'blocked' | 'returned'

The status of the transfer.

createdAtstring

The entity's date and time of creation, in ISO 8601 format.

testmodeboolean nullable

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.

Example response

{
  "resource": "business-account-transfer",
  "id": "batrf_87GByBuj4UCcUTEbs6aGJ",
  "mode": "live",
  "debtorIban": "NL55MLLE0123456789",
  "debtor": {
    "fullName": "Jan Jansen",
    "account": {
      "iban": "NL02ABNA0123456789"
    }
  },
  "creditor": {
    "fullName": "Jan Jansen",
    "account": {
      "iban": "NL02ABNA0123456789"
    }
  },
  "amount": {
    "currency": "EUR",
    "value": "10.00"
  },
  "description": "Invoice 12345",
  "businessAccountTransactionId": "batr_87GByBuj4UCcUTEbs6aGJ",
  "transferScheme": {
    "type": "sepa-credit-inst"
  },
  "creditDebitIndicator": "debit",
  "status": "initiated",
  "statusHistory": [
    {
      "status": "initiated",
      "createdAt": "2024-03-20T09:13:37+00:00",
      "statusReason": {
        "code": "insufficient-funds",
        "message": "The creditor account does not exist."
      }
    }
  ],
  "createdAt": "2024-03-20T09:13:37+00:00",
  "statusReason": {
    "code": "insufficient-funds",
    "message": "The creditor account does not exist."
  }
}

Changes

  • 7cab62b21830Revision changes
    • info

      added the non-success response with the status

  • ef4b5a97b56aRevision changes
    • info

      the endpoint scheme security advancedAccessToken was added to the API

    • info

      the endpoint scheme security organizationAccessToken was removed from the API

    • info

      removed subschema #2 from the response body allOf list for the response status