Sign in
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.

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

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Request body

paymentIdsPaymentToken[] 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.

Changes

Changed in 2 of the 92 revisions of this API.3

  • 7cab62b218301See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

  • ef4b5a97b56a2See the full diff
    • ○

      the endpoint scheme security advancedAccessToken was added to the API

      api-security-added

    • ○

      the endpoint scheme security organizationAccessToken was removed from the API

      api-security-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 92 revisions, 9 have no diff computed.