GRgreendot
Purse

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

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.

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

Request

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

Path parameters

accountIdentifierstring required

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

programCodestring required

The unique code identifying the partner program context.

Headers

X-GD-RequestIdstring required

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

Request body

purseTypestring nullable

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

purseDescriptionstring nullable

The description of the purse.

goalAmountnumber double nullable

The goal amount for the purse, if applicable.

goalDatestring nullable

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

iconNamestring nullable

The icon name for the purse.

interestRateTierstring nullable

The interest rate tier for the purse, if applicable.

interestYieldStartDatestring nullable

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

autoAlignStartDateboolean

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

purseSubTypestring nullable

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

Response

OK

Changes

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