Sign in

v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
card-order

Create a card order

Creates a new card order. The program field value is retrieved from the retrieve all card programs endpoint.

{% admonition type="warning" %} This request requires an extra field in the header, X-idempotence-uuid. This should be generated and used for any subsequent retries in the event that the initial request fails. {% /admonition %}

When you issue a card under a business profile, the cardholder will automatically default to the business representative.

If the cardholder is not the business representative, create a cardholder personal profile and add the profileId of the cardholder profile to the cardHolderProfileId field on the card order request.

For country-specific address fields and validation rules, see the card address validation guide.

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

Path parameters

profileIdinteger required

The profile ID (personal or business).

Headers

X-idempotence-uuidstring uuid required

Idempotency key. Should be generated and used for any subsequent retries.

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.

Request body

programstring required

The name of the card program.

cardHolderNamestring required

The cardholder's name.

embossedNamestring

The cardholder's name to print on the card (physical card only). The field length should be between 1 and 22 characters (spaces included).

phoneNumberstring

For partners onboarded after 1/3/2025, we will use the profile phone number for any Card-related One-Time Password (OTP) requests. See 3ds. Ensure that the phone number is valid and starts with a "+" followed by the country code.

deliveryOption'POSTAL_SERVICE_STANDARD' | 'POSTAL_SERVICE_WITH_TRACKING' | 'KIOSK_COLLECTION'

The delivery method for the card order. The delivery method will be defined during scoping phase. Please reach out to your Implementation Manager for more information.

Only specify this field for KIOSK_COLLECTION. If not specified, the default delivery method for your region will be used.

  • POSTAL_SERVICE_STANDARD - Default delivery method. Not traceable.
  • POSTAL_SERVICE_WITH_TRACKING - Available in certain regions. Default in Brazil.
  • KIOSK_COLLECTION - Available in select regions. See the kiosk collection guide.
lifetimeLimitnumber

Optionally sets a lifetime spending limit on the card. A lifetime limit of 0 means that a card cannot be used until the lifetime limit is updated.

cardHolderProfileIdinteger

The cardholder profile for this card. This is used for business profiles.

Example request

{
  "program": "VISA_DEBIT_BUSINESS_UK_1_PHYSICAL_CARDS_API",
  "cardHolderName": "John Smith",
  "embossedName": "Smith John",
  "phoneNumber": "+441234567890",
  "address": {
    "firstLine": "56 Shoreditch High St",
    "secondLine": "The Tea Bldg",
    "city": "London",
    "postCode": "E1 6JJ",
    "country": "GB"
  },
  "lifetimeLimit": 100,
  "cardHolderProfileId": 654321,
  "replacementDetails": {
    "cardToken": "4a75fdb7-5791-49ac-832c-81c4347e4df0",
    "reason": "CARD_DAMAGED"
  }
}

Response

OK - Card order created successfully.

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