Endpoint:
Method: POST
Type: FORMDATA
URL: {{API_BASE_URL}}/cards/update
Request Parameter
| Parameter | Required | Type | Description |
|---|---|---|---|
| card_number | Y | string | card number |
| auto_topup | N | int | turn on auto top-up (0 or 1) |
| auto_topup_rule | N | object | for standard card: {"min_balance":10,"topup_amount":10},means top-up $10 when balance is less than $10 for shared card: {"min_balance":10,"require_balance":10}, means update balance to $10 when balance is less than $1 |
| shared_card_balance | N | float | shared card only. update available balance of card (0-50000) |
| shared_card_balance_unlimit | N | int | shared card only. when value is 1, means balance unlimit. when value is 0, means balance is limit to "shared_card_balance" |
| single_transaction_limit | N | float | the max single transaction amount limit |
| single_transaction_unlimit | N | int | single transaction amount unlimit (0 or 1) |
Request Example (Standard Card):
{
"card_number": "5329000000000000",
"auto_topup": 1,
"auto_topup_rule": {
"min_balance": 10,
"topup_amount": 50
},
"single_transaction_limit": 100,
"single_transaction_unlimit": 0
}
Request Example (Shared Card):
{
"card_number": "5329000000000001",
"auto_topup": 1,
"auto_topup_rule": {
"min_balance": 10,
"require_balance": 100
},
"shared_card_balance": 100,
"shared_card_balance_unlimit": 0,
"single_transaction_limit": 50,
"single_transaction_unlimit": 0
}
Response
| Field | Type | Description |
|---|---|---|
| card_number | string | card number |
| auto_topup | int | Turn on auto top-up |
| auto_topup_rule | object | auto top-up rule |
| shared_card_balance | float | shared card only. card available balance |
| shared_card_balance_unlimit | int | shared card only. when value is 1, means balance unlimit. |
| single_transaction_limit | float | the max single transaction amount limit |
| single_transaction_unlimit | int | single transaction amount unlimit |
Status: 200
Status: 403 (Forbidden)
Status: 404 (Not Found)
Status: 500 (Internal Server Error)
Response Example:
{
"card_number": "5329000000000000",
"auto_topup": 1,
"auto_topup_rule": {
"min_balance": 10,
"topup_amount": 50
},
"single_transaction_limit": 100,
"single_transaction_unlimit": 0
}