GRgreendot
Purse

POST /programs/{programCode}/accounts/{accountIdentifier}/purses/{purseIdentifier}/CreditBuilder/payment

Processes a payment on an existing Credit Builder purse associated with an account. Only allowed if the account status is normal. Returns the payment result, including transfer identifier and status.

Request

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

Path parameters

accountIdentifierstring required
programCodestring required
purseIdentifierstring required

Headers

X-GD-RequestIdstring required

Request body

programCodestring nullable
accountIdentifierstring nullable
purseIdentifierstring nullable
paymentAmountOption'FixedAmount' | 'StatementBalance' | 'MinimumPayment' | 'CurrentBalance'
paymentAmountnumber double

Response

OK

transferIdentifierstring required

Required : TransferIdentifier

transferStatusstring nullable

Required : Transfer status

Changes

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