MOmollie
Unmatched Credit Transfers API

Get unmatched credit transfer

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

🔑 Access with

API key

Advanced access token with unmatched-credit-transfers.read

OAuth access with unmatched-credit-transfers.read

get/unmatched-credit-transfers/{unmatchedCreditTransferId}

Request

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

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

The identifier uniquely referring to this unmatched credit transfer.

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.

statusstring required

The status of the unmatched credit transfer.

Possible values: received matched returned expired

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.

paymentIdsstring[]

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

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