Purse

Get Purses – Retrieves all purses and balances for an account.

Retrieves all purses and balances for an account, including available and ledger balances. Returns purse details and transfer status.

get/programs/{programCode}/accounts/{accountIdentifier}/purses

Request

  • The document declares no server URL.
  • Auth
    API key in header Authorization

Path parameters

programCodestring required

The unique code identifying the partner program context.

accountIdentifierstring required

The unique identifier of the account whose purses are being retrieved.

Headers

X-GD-RequestIdstring required

The unique request identifier (GUID) for tracking and idempotency. Required in the X-GD-RequestId header.

Response

OK

purseBalanceTransferStatus'undefined' | 'ActivityNotFound' | 'Succeed' | 'InProgress' | 'Declined' | 'Failed' | 'InternalServerError' nullable

The transfer status for purse balances, if applicable.

Changes

No recorded changes to this operation across all 2 revisions of this API.