Skip to main content
POST
/
cards
curl --request POST \
  --url https://api.equalsmoney.com/v2/cards \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
  "name": "Team Party",
  "cardOwnerType": "BUDGET",
  "budgetCardPhoneNumber": "+447911001762",
  "budgetCardPhoneNumberPersonId": "775596ae-2624-40af-a9dc-9756110a4a08",
  "mfa": {
    "sessionId": "string",
    "token": "string"
  }
}
'
{
  "id": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
  "personId": "775596ae-2624-40af-a9dc-9756110a4a04",
  "accountId": "F50091",
  "careOfLine": "string",
  "cardProductName": "string",
  "lastFour": "0056",
  "expiration": "0111",
  "expirationTime": "2025-01-31T23:59:59Z",
  "pinIsSet": true,
  "state": "ACTIVE",
  "stateReason": "New card",
  "fulfillmentStatus": "ISSUED",
  "fulfillment": {
    "shippingMethod": "COURIER"
  },
  "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": "831555555"
  },
  "cardOwnerType": "PEOPLE",
  "name": "Team Party Card",
  "budgetCardPhoneNumber": "+447911001762",
  "meta": [
    {
      "id": "string",
      "cardId": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
      "CardId": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
      "metaKey": "expirationTime",
      "metaValue": "New card",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "budgets": [
    {
      "id": "775596ae-2624-40af-a9dc-9756110a4a03",
      "name": "Engineering",
      "type": "accountBalance",
      "access": "allowed"
    }
  ],
  "budget": {
    "id": "775596ae-2624-40af-a9dc-9756110a4a03",
    "name": "Engineering",
    "type": "accountBalance",
    "access": "allowed"
  },
  "spendingLimit": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "amount": 100.5,
    "currencyCode": "GBP",
    "active": true,
    "usageLimit": 15,
    "limitTurnedOff": true,
    "limitWindow": "DAY",
    "available": {
      "uses": 0,
      "amount": 100.5,
      "daysRemaining": 1
    }
  },
  "transactionLimit": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "amount": 100.5,
    "currencyCode": "GBP",
    "active": true,
    "limitTurnedOff": true,
    "limitWindow": "TRANSACTION"
  },
  "budgetCardPhoneNumberPersonId": "3f0ed336-6bdd-4498-b45f-514a625c72e1",
  "previousCards": [
    null
  ],
  "currencies": [
    {
      "numericCode": "840",
      "code": "USD"
    }
  ],
  "baseCurrencyCode": "string",
  "physicalCardState": "ACTIVE",
  "physicalCardId": "98e7d110-00ea-45f1-9af7-2dac397a7138",
  "forceChangePin": true,
  "cardGroupId": "ef3dcbc9-9ad4-44c0-8d75-217d31da37b8",
  "cardProductId": "06776ac8-abe1-475b-92ee-72405c7b0e60",
  "cardProductToken": "2f224848-4191-4180-a090-3926042e4b39",
  "userTokenId": "187f5207-de0b-4f4e-9b90-d50d6a251c6b",
  "cardPersonalization": {
    "text": {
      "nameLine_1": {
        "value": "string"
      },
      "nameLine_2": {
        "value": "string"
      }
    }
  },
  "fundingSourceBudgetId": "dd3429fe-77dd-49d7-9f2d-81f114257fe2",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
accountId
string
required

The ID of the account to work with.

Example:

"F50091"

Body

application/json

Body

​
budgetId
string<uuid>
required

The ID of the budget to work with.

Maximum string length: 36
Example:

"775596ae-2624-40af-a9dc-9756110a4a03"

​
cardOwnerType
enum<string>
required

The type of card owner.

Available options:
BUDGET
Example:

"BUDGET"

​
name
string

The name of the card. Any diacritics will be converted to the nearest English letter equivalent. Note that any name that is longer than 21 characters will be truncated.

Required string length: 1 - 255
Example:

"Team Party"

​
budgetCardPhoneNumber
string

The telephone number of the shared card (including area code), prepended by the + symbol and the 1- to 3-digit country calling code. Do not include hyphens, spaces, or parentheses.

Example:

"+447911001762"

​
budgetCardPhoneNumberPersonId
string<uuid>

The ID of the person that should receive shared card notifications.

Maximum string length: 36
Example:

"775596ae-2624-40af-a9dc-9756110a4a08"

​
mfa
object

Response

201 - application/json

Created

​
id
string<uuid>
required

The ID of the card to work with.

Maximum string length: 36
Example:

"e9293471-5eb3-4dbc-916c-dbaf9e2deefd"

​
accountId
string
required

The ID of the account to work with.

Example:

"F50091"

​
lastFour
string
required

The last four digits of the card Primary Account Number (PAN).

Example:

"0056"

​
state
enum<string>
required

The current state of the card.

Available options:
ACTIVE,
REPLACED,
TERMINATED,
SUSPENDED,
UNACTIVATED
Example:

"ACTIVE"

​
cardType
enum<string>
required

The type of card.

Available options:
VIRTUAL_PAN,
PHYSICAL_MSR,
PHYSICAL_COMBO
Example:

"PHYSICAL_MSR"

​
name
string
required

The name of the card.

Example:

"Team Party Card"

​
personId
string<uuid> | null

The ID of the person to work with.

Maximum string length: 36
Example:

"775596ae-2624-40af-a9dc-9756110a4a04"

​
careOfLine
string | null

Adds the specified value as a C/O (care of) line to the mailing carrier.

​
cardProductName
string

The card product name.

​
expiration
string

The expiration month and year of the card.

Example:

"0111"

​
expirationTime
string

The expiration time of the card.

Example:

"2025-01-31T23:59:59Z"

​
pinIsSet
boolean

Whether or not the card PIN is set.

​
stateReason
string

The reason for current card state.

Example:

"New card"

​
fulfillmentStatus
enum<string>

The fulfillment status of the card.

Available options:
ISSUED,
ORDERED,
REORDERED,
REJECTED,
SHIPPED,
DIGITALLY_PRESENTED
Example:

"ISSUED"

​
fulfillment
object
​
recipientAddress
object

Details about the address that the card will be shipped to.

​
cardOwnerType
enum<string>

The card owner type of the card.

Available options:
PEOPLE,
BUDGET
​
budgetCardPhoneNumber
string | null

The telephone number of the shared card (including area code), prepended by the + symbol and the 1- to 3-digit country calling code. Do not include hyphens, spaces, or parentheses.

Example:

"+447911001762"

​
meta
object[]

List of metas.

​
budgets
object[]

List of budgets.

​
budget
object
​
spendingLimit
object
​
transactionLimit
object
​
budgetCardPhoneNumberPersonId
string<uuid> | null

The ID of the person that should receive the shared card notifications.

Maximum string length: 36
​
previousCards
any[]

List of all previous cards.

​
currencies
object[]

List of all currency codes which belong to the card product token of the card.

​
baseCurrencyCode
string

The base currency code of the card product token of the card.

​
physicalCardState
enum<string>

The state of the corresponding physical card.

Available options:
ACTIVE,
REPLACED,
TERMINATED,
SUSPENDED,
UNACTIVATED,
NOT_REQUESTED,
PENDING_ACTIVATION
​
physicalCardId
string<uuid> | null

The ID of the corresponding physical card.

​
forceChangePin
boolean

Whether or not the PIN needs to be changed.

​
cardGroupId
string<uuid> | null

The ID of the card group to work with.

​
cardProductId
string<uuid> | null

The ID of the card product to work with.

​
cardProductToken
string<uuid> | null

The ID of the card product token to work with.

​
userTokenId
string<uuid> | null

The ID of the user token to work with.

​
cardPersonalization
object

The line of personalised text that will be printed on the card.

​
fundingSourceBudgetId
string<uuid> | null

The ID of the funding source budget.

Maximum string length: 36
​
createdAt
string<date-time>

The date the Resource was initially created. ISO 8601 format without milliseconds.

​
updatedAt
string<date-time>

The date the Resource was last modified. ISO 8601 format without milliseconds.