Get match

GET https://api.invunion.com/api/v1/matches/:id matches:read Markdown

Get one match by UUID.

Returns the match with joined transaction and invoice fields, including invoice dates and settlement amounts.

Matches have no business code, and the Invunion UI does not show the match UUID. Identify a match with invoice number and transaction code: List matches with invoiceId and transactionId, or read matches[].id on Get invoice / Get transaction. Create match and match webhooks also return id. Use this endpoint only after you already have that UUID.

See also

  • Matches . Which call to use for each change.
  • List matches (GET/api/v1/matches). Find the UUID by invoice number and transaction code.
  • Get invoice (GET/api/v1/invoices/:code). Live matches nested on the invoice, including id.
  • Get transaction (GET/api/v1/transactions/:code). Live matches nested on the transaction, including id.

Path parameters

NameTypeRequired
id

Match UUID.

Example: 1c9e6679-7425-40de-944b-e07fc1f90ae7

string

No maximum

Required

Errors

This operation can return the following errors in addition to generic HTTP failures.

Error HTTP code Description
Missing Bearer token 401 The Authorization header is missing or is not a Bearer token.
Invalid or revoked API key 401 The API key is unknown, malformed, expired, or has been revoked.
API key is missing scope matches:read 403 The key does not include matches:read. A write scope does not imply the matching read scope.
Too many requests, please try again later 429 Wait and retry. The Retry-After header is the number of seconds to wait.
Match not found 404 No match with this UUID exists in the authenticated tenant.
Internal server error 500 Unexpected server error. The JSON body includes correlationId. Retry with backoff.
Previous: List matches Next: Create match