Sign in

v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
card-order

Retrieve a card order

Retrieves a card order based on the cardOrderId.

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

Path parameters

profileIdinteger required

The profile ID (personal or business).

cardOrderIdinteger required

The card order ID.

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 order.

idinteger

ID of the card order.

profileIdinteger

Profile ID.

clientIdstring

Client ID.

cardTokenstring nullable

Token of the card associated with card order. Nullable.

replacesCardstring nullable

A string for replacement card. Not supported at the moment.

creationTimestring date-time

Time when the card order is created.

modificationTimestring date-time

Time when the card order was last modified.

status'PLACED' | 'REQUIREMENTS_FULFILLED' | 'CARD_DETAILS_CREATED' | 'PRODUCED' | 'COMPLETED' | 'CANCELLED' | 'RETURNED'

Status of the card order. See card order status flow for details.

cardHolderNamestring

Name of the card holder.

phoneNumberstring

Phone number associated with the card order.

lifetimeLimitnumber nullable

Maximum amount of spending on the card once issued. Nullable.

deliveryEstimatestring date-time

The estimated time when the card will be delivered. There are few scenarios to be mindful of:

  1. For virtual card the delivery estimate will be close to the creationTime, as it does not require delivery.
  2. For physical card in PLACED status, the delivery estimate is calculated assuming that the order requirements will be fulfilled today (refreshed daily).
  3. For physical card after PLACED status, we provide a best effort estimation, and it should not be used as delivery timing as we will have separate delivery tracking (subject to region availability) for physical card that is coming soon.

Example response

{
  "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"
  }
}