Purses API Endpoints

Obtain Primary Account Balances

This endpoint retrieves balances (i.e., Available, Ledger) associated with the primary account.

Response Parameters

Purse Descriptions

📘

The following characters can be used in purse descriptions.

Note: Forward and Backward slashes are not allowed.

Add a Savings Purse

This endpoint allows the addition of a savings purse.

🚧

A savings purse can only be created if the customer’s account status is normal.

Interest Rate Tier information is only included in responses to POST /purses calls/requests that include interestRateTier. Refer to Interest Rate/Endpoint: POST /purses for calls/requests that include interestRateTier information.

Response Parameters

Restricted Accounts

Partners can update purses on accounts that are restricted with a cure (kycGate) by calling the below endpoint:

See KYC in the Enrollments APIs for more information about KYC verification.

Response Codes

Update a Purse

This endpoint allows Partners to update a specific purse.

Response Codes

Close an Empty Balance Non-Spending Purse

This endpoint is used to close and delete an Empty Balance Non-Spending Purse

API Call Structure

DELETE /programs/{programCode}/accounts/{accountIdentifier}/purses/{purseIdentifier}

API Call Structure Parameters

• X-GD-RequestID (required header)
• programCode (required)
• accountIdentifier (required)
• purseIdentifier (required)

For more details, refer to Structure of API Calls.

Sample Response Body

{
   "responseDetails":[
      {
         "code":0,
         "subCode":0,
         "description":"Success",
         "url":"http://tbd"
      }
   ]
}