API Reference

Add Purse – Creates a new savings purse for an account.

post
https://example.com/programs//accounts//purses

Creates a new savings purse for an account. Only allowed if the account status is normal. Interest Rate Tier information is included if provided. Returns the created purse details.

Path Params
string
required

The unique identifier of the account for which the purse is created.

string
required

The unique code identifying the partner program context.

Body Params

The Gd.Bos.DataTransfer.Request.CreatePurseRequest object containing purse details, such as type, description, goal amount, and interest rate tier.

string | null

The type of purse to create (e.g., "Savings", "General").

string | null

The description of the purse.

double | null

The goal amount for the purse, if applicable.

string | null

The goal date for the purse, if applicable (YYYY-MM-DD).

string | null

The icon name for the purse.

string | null

The interest rate tier for the purse, if applicable.

string | null

The start date for interest yield (YYYY-MM-DD).

boolean

Indicates whether to auto-align the start date for interest calculation.

string | null

The sub-type of the purse (e.g., "General", "Taxes", "Goal").

Headers
string
required

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

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json

Updated 2 months ago