post https://api.staging.pungle.co/api/v1/card_issuing/value_loads/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
Parameter | Required | Data type | Notes |
---|---|---|---|
account_id | Yes | Integer | Id of an Account |
external_tag | Yes | String | User defined external reference field to store on Value Load |
amount | Yes | Integer | Smallest unit of the Programs currency. For example, $10.00 CAD would be sent at 1000 |
message | No | String | Alphanumeric string including punctuation |
idempotency_key | No | string | |
transaction_code | No | String | Controls 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 Name | Type | Description |
---|---|---|
id | Integer | Value Load ID |
external_tag | String | User defined external reference field to store on Value Load |
amount | Integer | Amount loaded onto Account in smalled unit of Programs Currency. For example, $10.00 CAD would be received as 1000 |
message | String | An optional message to store on the Value Load |
account_id | Integer | ID of the Account that the Funds where loaded on to |