MOmollie
Unmatched Credit Transfers API

Get unmatched credit transfer

Changed on

🚧 Beta feature

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

Retrieves a single unmatched credit transfer by its identifier.

get/v2/unmatched-credit-transfers/{unmatchedCreditTransferId}

Request

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

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 unmatched credit transfer object.

resourcestring required

Indicates the response contains an unmatched credit transfer object. Will always contain the string unmatched-credit-transfer for this endpoint.

idstring required
profileIdstring required

The identifier referring to the profile this entity belongs to.

Most API credentials are linked to a single profile. In these cases the profileId can be omitted in the creation request. For organization-level credentials such as OAuth access tokens however, the profileId parameter is required.

status'received' | 'matched' | 'returned' | 'expired' required
createdAtstring required

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

expiresAtstring required

The date and time at which the unmatched credit transfer expires, in ISO 8601 format.

paymentIdsPaymentToken[]

The IDs of the payments this credit transfer was matched to. Only present when the status is matched.

Example response

{
  "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"
    },
    "documentation": {
      "href": "https://docs.mollie.com/reference/get-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