v5

latestOpenAPI 3.1.02026-07-262421791.5 MB

card-order

Retrieve all card orders

Retrieves a list of card orders created for the specified profileId.

get/v3/spend/profiles/{profileId}/card-orders

Path parameters

profileIdinteger required

The profile ID (personal or business).

Query parameters

pageSizeinteger

The maximum number of card orders to return per page. This number can be between 10 - 100, and will default to 10.

pageNumberinteger

The page number to retrieve the next set of card orders. The number has to be greater or equal to 1, and will default to 1.

Headers

X-External-Correlation-Idstring uuid

Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Response

OK - Successfully retrieved card orders.

totalCountinteger

The total number of card orders for this profile.

Example response

{
  "totalCount": 5,
  "cardOrders": [
    {
      "id": 142,
      "profileId": 123456,
      "clientId": "your-client-id",
      "cardProgram": {
        "name": "VISA_DEBIT_BUSINESS_UK_1_PHYSICAL_CARDS_API",
        "scheme": "VISA",
        "defaultCurrency": "GBP",
        "cardType": "PHYSICAL"
      },
      "address": {
        "firstLine": "56 Shoreditch High St",
        "secondLine": "The Tea Bldg",
        "city": "London",
        "postCode": "E1 6JJ",
        "country": "GB"
      },
      "cardToken": "4dc0be88-903f-49e4-8237-735f1139e3dd",
      "creationTime": "2023-07-31T01:43:24.596321434Z",
      "modificationTime": "2023-07-31T01:43:24.596321825Z",
      "status": "PRODUCED",
      "cardHolderName": "John Smith",
      "phoneNumber": "+441234567890",
      "lifetimeLimit": 100,
      "deliveryEstimate": "2023-10-30T07:11:00.848681Z",
      "deliveryDetails": {
        "deliveryOption": "POSTAL_SERVICE_WITH_TRACKING",
        "deliveryVendor": "DHL",
        "trackingUrl": "https://www.dhl.com/gb-en/home/tracking/tracking-express.html?submit=1&tracking-id=1999473803",
        "trackingNumber": "1999473803"
      }
    }
  ]
}