MOmollie
Unmatched Credit Transfers API

List unmatched credit transfers

🚧 Beta feature

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

Retrieves a list of unmatched credit transfers for the profile.

The results are paginated.

🔑 Access with

API key

Advanced access token with unmatched-credit-transfers.read

OAuth access with unmatched-credit-transfers.read

get/unmatched-credit-transfers

Request

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

Query parameters

fromstring
Example:uct_abcDEFghij123456789

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.

Response

A list of unmatched credit 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": {
    "unmatched-credit-transfers": [
      {
        "resource": "unmatched-credit-transfer",
        "id": "uct_abcDEFghij123456789",
        "profileId": "pfl_5B8cwPMGnU",
        "amount": {
          "currency": "EUR",
          "value": "10.00"
        },
        "source": {
          "format": "iban",
          "accountHolderName": "Jan Jansen",
          "iban": "NL91ABNA0417164300",
          "bic": "ABNANL2A"
        },
        "remittanceInformation": {
          "references": {
            "creditorReference": "RF33678094651239",
            "endToEndId": "NOTPROVIDED"
          }
        },
        "status": "received",
        "createdAt": "2024-03-20T09:13:37+00:00",
        "expiresAt": "2024-03-22T09:13:37+00:00",
        "paymentIds": [
          "tr_5B8cwPMGnU"
        ],
        "_links": {
          "self": {
            "href": "https://api.mollie.com/v2/unmatched-credit-transfers/uct_abcDEFghij123456789",
            "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

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