Cards

Card APIs are only available for the Enterprise customers.

Interested? Contact us via: [e-mail]

AlphaX offers a standout feature called "Card," which enables companies to create and distribute virtual cards for employee.

We have several Card APIs available to streamline your workflow and ensure smooth operations. These APIs are designed to integrate seamlessly into your existing systems, providing enhanced functionality and improving productivity.

Cards listing API

GET https://public-api.alphax.asia/cards

Accepted query params:

• keyword : to filter by keyword (name, description, nameOnCard, last4)

• page : for pagination, by default: 1

• limit : for pagination, by default: 10

Response:

{
    "cards": [
        {
            "id": "card id",
            "name": "card custom label - name",
            "description": "Card description",
            "last4": "4152",
            "nameOnCard": "Your Company Name",
            "type": "company",
            "status": "Creating|Active|Pending|Frozen|Closed",
            "brand": "VISA",
            "cardholder": {
                "email": "card holder email - user on AlphaX",
                "name": "card holder name - user on AlphaX"
            },
            "detailUrl": "<url to view card details on AlphaX>",
            "createdAt": "iso datetime",
            "updatedAt": "iso datetime"
        }
    ],
    "pagination": {
        "currentPage": 1,
        "totalPages": 1,
        "perPage": 10
    }
}

Create Card API

This API allows you to create "Company Card" only. If you want to create Employee card, please visit our WebApp to create: https://app.alphax.asia.

POST https://public-api.alphax.asia/cards

Request body (must be application/json)

{
    "name": "Card Label Name Here",
    "description": "Card Description. E.g.: payment, subscription, etc. Can be null/undefined",
    "cardholderEmail": "The email of your user on AlphaX - to be the cardholder of this card"
    "category": "Spending Category. Lists below",
    "frequency": "Can be null/undefined. Value: DAILY|WEEKLY|MONTHLY|ALL_TIME",
    "limitPerFrequency": "Can be null/undefined. The total limit per frequency. E.g.: 2000.50",
}

Spending Categories

BusinessExpenses
ClientExpenses
MarketingExpenses
OfficeSupplies
OnlinePurchasing
Other
Subscriptions
TeamExpenses
TravelExpenses

Response:

• 201 : successfully created a new card, card will be activated in the next 5~10 mins.

• 422 : validation errors

Update Card Spending Limit API

PATCH https://public-api.alphax.asia/cards/{cardId}/spend-settings

Request:

{    
    // configure limit amount per transaction (e.g.: it mustn't exceed 500$ per charge)
    "isUnlimitedLimitPerTransaction": false, // true or false
    "limitPerTransaction": 1000, // must have a valid number if "isUnlimitedLimitPerTransaction" is false
    
    // configure limit per frequency
    "isEnabledLimitPerPeriod": true, // true or false
    "totalLimit": 5000, // must have a valid number if "isEnabledLimitPerPeriod" is true
    "totalLimitFrequency": "DAILY", // DAILY|WEEKLY|MONTHLY|ALL_TIME, must have a valid option if "isEnabledLimitPerPeriod" is true
    
    // limit currency
    "isAllowedAllCurrencies": false, // true or false,
    "allowedCurrencies": ['USD', 'GBP'], // must have a list of currencies if "isAllowedAllCurrencies" is false
}

Response:

• 200 : successfully frozen the given card by id

• 403 & 404 : invalid cards

• 422 :

  • Card is in a budget

  • Card is not in Active or Frozen status

Freeze Card API

PATCH https://public-api.alphax.asia/cards/{cardId}/freeze

Response:

• 200 : successfully frozen the given card by id

• 403 & 404 : invalid cards

• 422 : card is not in Active status

Unfrozen Card API

PATCH https://public-api.alphax.asia/cards/{cardId}/unfrozen

Response:

• 200 : successfully unfrozen the given card by id

• 403 & 404 : invalid cards

• 422 : card is not in Frozen status

Close Card API

PATCH https://public-api.alphax.asia/cards/{cardId}/close

Response:

• 200 : successfully closed the given card by id

• 403 & 404 : invalid cards

• 422 : card is not in Active or Frozen status