/ Guides / Cards / Order cards / Order physical cards

Order physical cards

Convert individual virtual cards into physical cards and order replacement cards.

Convert a virtual card into a physical card

Post/v2/cards/{cardId}/convert-to-physical

Request

Use this request to convert an existing virtual card into a physical card. The virtual card will remain active until the physical card is activated. Once the physical card is activated, the virtual card will automatically be terminated.

info

You can only convert an individual card, not a shared one.

Sample requestRequest structure
Copy
Copied
curl -i -X POST \
  'https://api.equalsmoney.com/v2/cards/e9293471-5eb3-4dbc-916c-dbaf9e2deefd/convert-to-physical?accountId=F12345&personId=775596ae-2624-40af-a9dc-9756110a4a04' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "pin": "1111",
    "recipientAddress": {
      "firstName": "Jane",
      "middleName": "Roger",
      "lastName": "Doe",
      "address1": "123 Henry St",
      "address2": "Suite 101",
      "city": "Porterville",
      "state": "CA",
      "postalCode": "93257",
      "country": "US",
      "phone": "8315555555"
    },
    "careOfLine": "Care of JRD"
  }'
Copy
Copied
curl -i -X POST \
  'https://api.equalsmoney.com/v2/cards/{cardId}/convert-to-physical?accountId={accountId}&personId={personId}' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "pin": "string",
    "recipientAddress": {
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "address1": "string",
      "address2": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string",
      "country": "string",
      "phone": "string"
    },
    "careOfLine": "string"
  }'

Path parameters

Parameter Description
cardId
string
required		 The ID of the virtual card that you want to convert.

Allowable values:
An existing cardId (<= 36 characters)

Query parameters

Parameter Description
accountId
string
required		 The ID of the account that the card is associated with.

Allowable values:
An existing accountId
personId
string
required		 The ID of the person that the card belongs to.

Allowable values:
An existing personId (<= 36 characters)

Request body schema

Parameter Description
pin
string		 The Personal Identification Number (PIN) that you want to assign to the card.

Allowable values:
4 characters
recipientAddress
object
required if addressId not provided		 Details about the recipient of the physical card.

Allowable values:
A valid recipientAddress containing the following fields: firstName, middleName, lastName, address1, address2, city, state, postalCode, country, phone
recipientAddress.firstName
string
required		 The recipient's first name.

Allowable values:
A valid string
recipientAddress.middleName
string		 The recipient's middle name.

Allowable values:
A valid string
recipientAddress.lastName
string
required		 The recipient's last name.

Allowable values:
A valid string
recipientAddress.address1
string
required		 The first line of the recipient's address.

Allowable values:
A valid string
recipientAddress.address2
string		 The second line of the recipient's address.

Allowable values:
A valid string
recipientAddress.city
string
required		 The recipient's city.

Allowable values:
A valid string
recipientAddress.state
string		 The recipient's state.

Allowable values:
A valid string
recipientAddress.postalCode
string
required		 The recipient's postal or ZIP code.

Allowable values:
A valid string
recipientAddress.country
string		 The recipient's country.

Allowable values:
A valid string
recipientAddress.phone
string		 The recipient's phone number.

Allowable values:
A valid string
addressId
string
required if recipientAddress not provided		 The ID of the address to send the physical card to.

Allowable values:
An existing addressId
careOfLine
string		 An optional, additional care of (C/O) line that will be added to the mailing carrier.

Allowable values:
A valid string

Response

If your request is successful, you'll receive a 201 response.

Sample responseResponse structure
Copy
Copied
{
  "id": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
  "personId": "f3e5ff26-28ff-4cd6-9b1b-e303a185a13a",
  "accountId": "F12345",
  "cardProductName": "string",
  "lastFour": "0056",
  "expiration": "0111",
  "expirationTime": "2025-01-31T23:59:59Z",
  "pinIsSet": true,
  "state": "UNACTIVATED",
  "stateReason": "New card",
  "fulfillmentStatus": "ISSUED",
  "cardType": "PHYSICAL_MSR",
  "recipientAddress": {
    "firstName": "Jane",
    "middleName": "Roger",
    "lastName": "Doe",
    "address1": "123 Henry St",
    "address2": "Suite 101",
    "city": "Porterville",
    "state": "CA",
    "postalCode": "93257",
    "country": "US",
    "phone": "8315555555"
  },
  "cardOwnerType": "PEOPLE",
  "name": "Team Party Card",
  "budgetCardPhoneNumber": "+447911001762",
  "meta": [
    {
      "id": "string",
      "cardId": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
      "metaKey": "expirationTime",
      "metaValue": "New card"
    }
  ],
  "budgets": [
    {
      "id": "775596ae-2624-40af-a9dc-9756110a4a03",
      "name": "Engineering"
    }
  ],
  "budget": {
    "id": "775596ae-2624-40af-a9dc-9756110a4a03",
    "name": "Engineering"
  },
  "spendingLimit": {
    "id": "775596ae-2624-40af-a9dc-9756110a4a03",
    "amount": 100.5,
    "active": false,
    "limitTurnedOff": true,
    "limitWindow": "DAY",
    "available": {
      "uses": 0,
      "amount": 100.5,
      "daysRemaining": 1
    }
  },
  "transactionLimit": {
    "id": "775596ae-2624-40af-a9dc-9756110a4a03",
    "amount": 100.5,
    "active": false,
    "limitTurnedOff": true,
    "limitWindow": "TRANSACTION"
  },
  "budgetCardPhoneNumberPersonId": "775596ae-2624-40af-a9dc-9756110a4a08",
  "previousCards": [
    null
  ],
  "currencies": [
    {
      "numericCode": "840",
      "code": "USD"
    }
  ],
  "physicalCardState": "ACTIVE",
  "physicalCardId": "884496ae-2624-40af-a9dc-9756110a4a18",
  "forceChangePin": false,
  "createdAt": "2021-01-30T08:30:00Z",
  "updatedAt": "2021-01-30T08:30:00Z"
}
Copy
Copied
{
  "id": "string",
  "personId": "string",
  "accountId": "string",
  "cardProductName": "string",
  "lastFour": "string",
  "expiration": "string",
  "expirationTime": "string",
  "pinIsSet": boolean,
  "state": "string",
  "stateReason": "string",
  "fulfillmentStatus": "string",
  "cardType": "string",
  "recipientAddress": {
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "country": "string",
    "phone": "string"
  },
  "cardOwnerType": "string",
  "name": "string",
  "budgetCardPhoneNumber": "string",
  "meta": [
    {
      "id": "string",
      "cardId": "string",
      "metaKey": "string",
      "metaValue": "string"
    }
  ],
  "budgets": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "budget": {
    "id": "string",
    "name": "string"
  },
  "spendingLimit": {
    "id": "string",
    "amount": number,
    "active": boolean,
    "limitTurnedOff": boolean,
    "limitWindow": "string",
    "available": {
      "uses": number,
      "amount": number,
      "daysRemaining": number
    }
  },
  "transactionLimit": {
    "id": "string",
    "amount": number,
    "active": boolean,
    "limitTurnedOff": boolean,
    "limitWindow": "string"
  },
  "budgetCardPhoneNumberPersonId": "string",
  "previousCards": [
    null
  ],
  "currencies": [
    {
      "numericCode": "string",
      "code": "string"
    }
  ],
  "physicalCardState": "string",
  "physicalCardId": "string",
  "forceChangePin": boolean,
  "createdAt": "string",
  "updatedAt": "string"
}

For more detailed information about this request and its response, see the API reference.

Order a replacement card

Post/v2/cards/{cardId}/replace

Request

Use this request to replace an existing card with a new one. A physical card will be replaced with a physical card and a virtual card will be replaced with a virtual card.

Sample requestRequest structure
Copy
Copied
curl -i -X POST \
  'https://api.equalsmoney.com/v2/cards/884496ae-2624-40af-a9dc-9756110a4a18/replace?accountId=F12345' \
  -H 'Content-Type: application/json' \
  -d '{
    "keepPan": true,
    "keepDigitalWalletTokens": true
  }'
Copy
Copied
curl -i -X POST \
  'https://api.equalsmoney.com/v2/cards/{cardId}/replace?accountId={accountId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "keepPan": boolean,
    "keepDigitalWalletTokens": boolean
  }'

Path parameters

Parameter Description
cardId
string
required		 The ID of the card that you want to replace.

Allowable values:
An existing cardId (<= 36 characters)

Query parameters

Parameter Description
accountId
string
required		 The ID of the account that the card is associated with.

Allowable values:
An existing accountId
personId
string		 The ID of the person that the card belongs to.

Allowable values:
An existing personId (<= 36 characters)

Request body schema

Parameter Description
keepPan
boolean		 Whether or not the new card should keep the same PAN as the old one. By default, this is set to false.

Allowable values:
true, false
keepDigitalWalletTokens
boolean		 Whether or not any existing digital wallet tokens should be reassigned to the new card. By default, this is set to true.

Allowable values:
true, false

Response

Sample responseResponse structure
Copy
Copied
{
  "id": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
  "personId": "f3e5ff26-28ff-4cd6-9b1b-e303a185a13a",
  "accountId": "F12345",
  "cardProductName": "string",
  "lastFour": "0056",
  "expiration": "0111",
  "expirationTime": "2025-01-31T23:59:59Z",
  "pinIsSet": true,
  "state": "UNACTIVATED",
  "stateReason": "New card",
  "fulfillmentStatus": "ISSUED",
  "cardType": "PHYSICAL_MSR",
  "recipientAddress": {
    "firstName": "Jane",
    "middleName": "Roger",
    "lastName": "Doe",
    "address1": "123 Henry St",
    "address2": "Suite 101",
    "city": "Porterville",
    "state": "CA",
    "postalCode": "93257",
    "country": "US",
    "phone": "8315555555"
  },
  "cardOwnerType": "PEOPLE",
  "name": "Team Party Card",
  "budgetCardPhoneNumber": "+447911001762",
  "meta": [
    {
      "id": "string",
      "cardId": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
      "metaKey": "expirationTime",
      "metaValue": "New card"
    }
  ],
  "budgets": [
    {
      "id": "775596ae-2624-40af-a9dc-9756110a4a03",
      "name": "Engineering"
    }
  ],
  "budget": {
    "id": "775596ae-2624-40af-a9dc-9756110a4a03",
    "name": "Engineering"
  },
  "spendingLimit": {
    "id": "775596ae-2624-40af-a9dc-9756110a4a03",
    "amount": 100.5,
    "active": false,
    "limitTurnedOff": true,
    "limitWindow": "DAY",
    "available": {
      "uses": 0,
      "amount": 100.5,
      "daysRemaining": 1
    }
  },
  "transactionLimit": {
    "id": "775596ae-2624-40af-a9dc-9756110a4a03",
    "amount": 100.5,
    "active": false,
    "limitTurnedOff": true,
    "limitWindow": "TRANSACTION"
  },
  "budgetCardPhoneNumberPersonId": "775596ae-2624-40af-a9dc-9756110a4a08",
  "previousCards": [
    null
  ],
  "currencies": [
    {
      "numericCode": "840",
      "code": "USD"
    }
  ],
  "physicalCardState": "ACTIVE",
  "physicalCardId": "884496ae-2624-40af-a9dc-9756110a4a18",
  "forceChangePin": false,
  "createdAt": "2021-01-30T08:30:00Z",
  "updatedAt": "2021-01-30T08:30:00Z"
}
Copy
Copied
{
  "id": "string",
  "personId": "string",
  "accountId": "string",
  "cardProductName": "string",
  "lastFour": "string",
  "expiration": "string",
  "expirationTime": "string",
  "pinIsSet": boolean,
  "state": "string",
  "stateReason": "string",
  "fulfillmentStatus": "string",
  "cardType": "string",
  "recipientAddress": {
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "country": "string",
    "phone": "string"
  },
  "cardOwnerType": "string",
  "name": "string",
  "budgetCardPhoneNumber": "string",
  "meta": [
    {
      "id": "string",
      "cardId": "string",
      "metaKey": "string",
      "metaValue": "string"
    }
  ],
  "budgets": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "budget": {
    "id": "string",
    "name": "string"
  },
  "spendingLimit": {
    "id": "string",
    "amount": number,
    "active": boolean,
    "limitTurnedOff": boolean,
    "limitWindow": "string",
    "available": {
      "uses": number,
      "amount": number,
      "daysRemaining": number
    }
  },
  "transactionLimit": {
    "id": "string",
    "amount": number,
    "active": boolean,
    "limitTurnedOff": boolean,
    "limitWindow": "string"
  },
  "budgetCardPhoneNumberPersonId": "string",
  "previousCards": [
    null
  ],
  "currencies": [
    {
      "numericCode": "string",
      "code": "string"
    }
  ],
  "physicalCardState": "string",
  "physicalCardId": "string",
  "forceChangePin": boolean,
  "createdAt": "string",
  "updatedAt": "string"
}

For more detailed information about this request and its response, see the API reference.