Skip to content

Retrieve Card

Endpoint

GET/api/v1/merchant/cards/{cardId}/

Used to retrieve information about a specific card.

Physical Card Status Definitions

Status Definition
CARD_NOT_ORDERED Physical Card has not been ordered yet.
CARD_IN_PRODUCTION The card is being manufactured and shipped to the cardholder's address with pending shipping details.
CARD_SENT_TO_USER The card is being processed by our logistics partner and getting shipped to the cardholder's address.
CARD_ACTIVATED The card has been activated by the cardholder and is ready for use.
NOT_PHYSICAL_CARD The card is not a physical card, and Physical Card Status is not applicable.

Note: - availableCredit: The maximum amount allowed to spend during standard authorization. Does not impact real-time authorization.

Path Parameters

Name Type Required Description
cardId string ✅ The unique identifier for the card.

Example Request

GET /api/v1/merchant/cards/{cardId}/

Response

{
  "cardName": "string",
  "secondaryCardName": "string",
  "cardType": "string",
  "last4": "string",
  "availableCredit": "string",
  "status": "ACTIVE",
  "freezeReason": "string",
  "statusReason": "string",
  "physicalCardStatus": "CARD_ACTIVATED",
  "shippingAddress": {
    "line1": "string",
    "line2": "string",
    "zone": "string",
    "city": "string",
    "postalCode": "string",
    "country": "HK"
  },
  "spendControl": {
    "spendControlCap": {
      "transactionLimit": "string",
      "dailyLimit": "string",
      "weeklyLimit": "string",
      "monthlyLimit": "string",
      "yearlyLimit": "string",
      "allTimeLimit": "string"
    },
    "spendControlAmount": {
      "dailySpent": "string",
      "weeklySpent": "string",
      "monthlySpent": "string",
      "yearlySpent": "string",
      "allTimeSpent": "string"
    },
    "atmControl": {
      "dailyFrequency": "string",
      "dailyWithdrawal": "string",
      "monthlyFrequency": "string",
      "monthlyWithdrawal": "string"
    }
  },
  "threeDSFowarding": true,
  "cardDesign": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "shippingInformation": {
    "bulkShippingID": "string",
    "sku": "string"
  },
  "meta": {
    "id": "string",
    "email": "user@example.com",
    "otpPhoneNumber": {
      "dialCode": 0,
      "phoneNumber": "string"
    }
  }
}

Response Codes

Status Code Description
200 OK Successfully retrieved card details.
400 Bad Request Invalid request parameters.
401 Unauthorized Authentication failed.
404 Not Found Card not found.
500 Internal Server Error Server error.