MOmollie
Unmatched Credit Transfers API

Match unmatched credit transfer

🚧 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.

🔑 Access with

API key

Advanced access token with unmatched-credit-transfers.write

OAuth access with unmatched-credit-transfers.write

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

Request

  • Base URL
    https://api.mollie.com/v2
  • 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

Request body

paymentIdsstring[] 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

The identifier uniquely referring to this unmatched credit transfer action.

unmatchedCreditTransferIdstring required

The identifier of the unmatched credit transfer this action belongs to.

action'match' | 'return' required

The action performed on the unmatched credit transfer.

status'pending' required

The current status of the action.

createdAtstring required

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

Example response

{
  "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

No recorded changes to this operation across all 2 revisions of this API.