Card

Get balance report status

Changed on Nov 3, 2026

Returns the status and summary of a balance-report request, along with any failed items. Successful items are counted in the summary, not listed individually.

get/cards/balance-reports/{requestId}

Request

Base URL
https://sandbox.api.caas.reap.global
Auth
API key in header x-reap-api-key
TypeScript
https://skmtc.dev/reap-global/apis/reap-api/docs/cards/balance-reports/:requestId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

requestIdstring uuid required

The requestId returned by POST /cards/balance-reports

Headers

Accept-Versionstring required

Specifies the API version to use for this request.

Response

Balance-report request status

requestIdstring uuid

status'PENDING' | 'PROCESSING' | 'COMPLETED' | 'COMPLETED_WITH_ERRORS'

failedItemsTruncatedboolean

True when more failures exist than are listed in failedItems

Changes

Nov 3, 2026beb4b8d4eb01 Revision changes
- info
  added the non-success response with the status

Operation history