MOmollie
Draft Transfers API

List draft transfers

Changed on

🚧 Beta feature

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

Retrieves a list of draft transfers created via this API for the organization.

The results are paginated.

In test mode, this returns synthetic draft transfers only, not your real data.

get/v2/business-accounts/draft-transfers

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/business-accounts/draft-transfers
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://my.mollie.com/oauth2/authorize
      Token URL: https://api.mollie.com/oauth2/tokens scopes: business-account-draft-transfers.read

Query parameters

fromstring nullable

Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.

limitinteger nullable
Example:50

The maximum number of items to return. Defaults to 50 items.

status'pending-review' | 'approved' | 'declined'

The status of the draft transfer.

Example:pending-review

Filter the list by draft transfer status. Omit to return draft transfers in any status.

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

A list of draft transfer objects.

countinteger required

The number of items in this result set. If more items are available, a _links.next URL will be present in the result as well.

The maximum number of items per result set is controlled by the limit property provided in the request. The default limit is 50 items.

Example response

{
  "count": 5,
  "_embedded": {
    "draft_transfers": [
      {
        "resource": "business-account-draft-transfer",
        "id": "badrt_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",
        "scheduledExecutionDate": "2025-03-01",
        "status": "pending-review",
        "statusReason": {
          "code": "deleted-by-creator",
          "message": "The draft transfer has been deleted by the user who created it"
        },
        "createdAt": "2024-03-20T09:13:37+00:00",
        "approvedAt": "2025-01-01T12:05:00+00:00",
        "declinedAt": "2025-01-01T12:05:00+00:00",
        "deletedAt": "2025-01-01T12:05:00+00:00",
        "_links": {
          "self": {
            "href": "https://api.mollie.com/v2/business-accounts/draft-transfers/badrt_87GByBuj4UCcUTEbs6aGJ",
            "type": "application/hal+json"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "previous": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "next": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Changes

  • 72604f3ea2bbRevision changes
    • info

      added to the // response property allOf list for the response status

    • info

      removed from the // response property allOf list for the response status

  • 3fb1b5127a6bRevision changes
    • info

      endpoint added