Cards

Endpoint:

Method: GET
Type: 
URL: {{API_BASE_URL}}/cards

Request Parameter：

Parameter Required Type Description
card_number N string card number, Multiple card numbers separate with comma
card_id N string card id, Multiple card ids separate with comma
card_type N string enumeration: standard, shared
alias N string card alias
last_four_digits N string card last four digits
status N string Status
task_id N integer Apply cards return task_id
page N integer page
per_page N integer page size (max 500)

Example request:

GET {{API_BASE_URL}}/cards?card_type=standard&status=activated&per_page=20

Response：

Field Type Description
data object data
card_number string card number
card_type string standard,shared
auto_topup int turn on auto top-up
auto_topup_rule object auto top-up rule
tags array card tag
shared_card_balance float shared card only. available balance of card
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
name string alias
currency string currency
last_four_digits string last four digits
available_balance float available balance
status string status
applied_at string applied at
username string card user
card_id string card id
email string user email
suggested_card_user string suggested cardHolder name
suggested_card_address string suggested billing address
suggested_card_zipcode string suggested zip code
meta object meta
pagination object pagination
total number total
count number count
per_page integer per page
current_page integer current page
total_pages integer total pages
links object links 
Status: 200

Example response:

{
    "data": [
        {
            "card_number": "5329000000000000",
            "name": null,
            "currency": "USD",
            "last_four_digits": "7218",
            "available_balance": 0.00,
            "status": "activated",
            "applied_at": "2020-05-11 18:44:29",
            "username": "user1",
            "card_id": "11aa22cc33dd44ddd",
            "email": "user1@example.com",
            "suggested_card_user": "Pollard",
            "suggested_card_address": "Unit 2302, 23/F, Tower 3",
            "suggested_card_zipcode": "609000",
            "card_type": "standard",
            "auto_topup": 0,
            "auto_topup_rule": null,
            "single_transaction_limit": 0,
            "single_transaction_unlimit": 1,
            "tags": []
        }
    ],
    "meta": {
        "pagination": {
            "total": 1,
            "count": 1,
            "per_page": 15,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}