MOmollie
Unmatched Credit Transfers API

Match unmatched credit transfer

Changed on

🚧 Beta feature

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

Matches an unmatched credit transfer to one or more payments, settling the funds accordingly.

post/v2/unmatched-credit-transfers/{unmatchedCreditTransferId}/match

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/unmatched-credit-transfers/{unmatchedCreditTransferId}/match
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or OAuth 2
      Authorization code: https://my.mollie.com/oauth2/authorize
      Token URL: https://api.mollie.com/oauth2/tokens scopes: unmatched-credit-transfers.write

Headers

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

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

Request body

paymentIdsPaymentToken[] required

The IDs of the payments to match against the unmatched credit transfer.

Example request

{
  "paymentIds": [
    "tr_5B8cwPMGnU"
  ]
}

Response

The unmatched credit transfer action object.

resourcestring required

The resource type of the object.

idstring required
unmatchedCreditTransferIdstring required
action'match' | 'return' required
status'pending' required
createdAtstring required

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

Example response

{
  "resource": "unmatched-credit-transfer-action",
  "id": "uct-act_xyz789",
  "unmatchedCreditTransferId": "uct_abcDEFghij123456789",
  "createdAt": "2024-03-20T09:13:37+00:00",
  "details": {
    "paymentIds": [
      "tr_5B8cwPMGnU"
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.mollie.com/v2/unmatched-credit-transfers/uct_abcDEFghij123456789/match",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://docs.mollie.com/reference/match-unmatched-credit-transfer",
      "type": "text/html"
    }
  }
}

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