v1

latestOpenAPI 3.1.0CC-BY-NC-SA-4.02026-07-2413803.8 MB
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 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.