Cards

circle-exclamation

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

circle-info

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.

Request body (must be application/json)

Spending Categories

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

Request:

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

Response:

  • 200 : successfully frozen the given card by id

  • 403 & 404 : invalid cards

  • 422 : card is not in Active status

Unfrozen Card API

Response:

  • 200 : successfully unfrozen the given card by id

  • 403 & 404 : invalid cards

  • 422 : card is not in Frozen status

Close Card API

Response:

  • 200 : successfully closed the given card by id

  • 403 & 404 : invalid cards

  • 422 : card is not in Active or Frozen status

Last updated