Create Value Unload

This call allows the user to Unload Funds from a cardholder account from the associated master funding account. The recipient's Account ID should be passed as a parameter.

Note: This method only work for active Reloadable cards. You may ask your Berkeley Implementation Manager for more information.
Note: This endpoint must be enabled on a per-program basis. Ask your Berkeley Implementation Manager for more information.

Request

ParameterRequiredData typeNotes
account_idYesIntegerId of an Account
external_tagYesStringUser defined external reference field to store on Value Load
amountYesIntegerSmallest unit of the Programs currency. For example, $10.00 CAD would be sent at 1000
messageNoStringAlphanumeric string including punctuation
idempotency_keyNostring
transaction_codeNoStringControls the message that is recorded as part of the transaction. Defaults to value_load See Transaction Codes section above for possible values

Only available for Canadian programs

Response

Field NameTypeDescription
idIntegerValue Load ID
external_tagStringUser defined external reference field to store on Value Load
amountIntegerAmount loaded onto Account in smalled unit of Programs Currency. For example, $10.00 CAD would be received as 1000
messageStringAn optional message to store on the Value Load
account_idIntegerID of the Account that the Funds where loaded on to
Query Params
string
Body Params
number
number
string
string
string
Response

Language
Credentials
Bearer
JWT
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json