GET/v1/collect/transactions/:transactionId

Collection transaction status

Resolve a collection by transactionId returned from POST /v1/collect, or by provider reference where applicable. Requires collections scope.

Headers

Authorization: Bearer <collections_access_token>

Responses

  • 200 — data.type must be COLLECTION for this route.
  • 403 — Token scope is disbursements-only, or row exists but is not a collection.
  • 404 — Unknown id for this merchant.

HTTP status codes (API reference)

Shared auth errors (401, wrong-scope 403, IP 403, 429): Errors overview.

HTTPWhen
200status: "success" and data with full transaction fields (type, status, amounts, failureReason, timestamps). data.type must be COLLECTION for this route.
403Row exists but is not a collection: This transaction is not a collection; use GET /v1/disburse/transactions/:transactionId with a disbursements-scoped token.
404Transaction not found
401 / 403 / 429See Errors overview for auth, scope, IP, and rate-limit errors.

Status values

Transaction status enum in the API includes PENDING, SUCCESS, FAILED, AMBIGUOUS.