v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
Purse

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.

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

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