Update cards

Update an existing card to change its state or its details, such as its name, linked budget, or the phone number associated with it. You can't update a card's PAN or CVV.

info

The endpoints described in this guide are currently in beta mode.

Update a card's details

Put/v2/cards/{cardId}

Request

Use this request to update the details about a given card.

Sample requestRequest structure

Copy

Copied

curl -i -X PUT \
  'https://api.equalsmoney.com/v2/cards/e9293471-5eb3-4dbc-916c-dbaf9e2deefd?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "personId": "775596ae-2624-40af-a9dc-9756110a4a04",
    "budgetCardPhoneNumberPersonId": "775596ae-2624-40af-a9dc-9756110a4a04",
    "budgetCardPhoneNumber": "+447911001762",
    "name": "Team Party"
  }'

Copy

Copied

curl -i -X PUT \
  'https://api.equalsmoney.com/v2/cards/{cardId}?accountId={accountId}' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "personId": "string",
    "budgetCardPhoneNumberPersonId": "string",
    "budgetCardPhoneNumber": "string",
    "name": "string"
  }'

Path parameters

Parameter	Description
`cardId` string required	The ID of the card that you want to update. Allowable values: An existing `cardId` (<= 36 characters)

Query parameters

Parameter	Description
`accountId` string required	The ID of the account associated with the card. Allowable values: An existing `cardId` (<= 36 characters)
`personId` string	The ID of the person that the card belongs to. Allowable values: An existing `personId` (<= 36 characters)

Request body schema

Parameter	Description
`personId` string	The ID of the person who owns the card, if the card is individual. Update this if you want to change the ownership of the card. Allowable values: A valid `personId` (<= 36 characters)
`budgetCardPhoneNumberPersonId` string	The person associated with the card, if the card is shared. Allowable values: An existing `personId` (<= 36 characters)
`budgetCardPhoneNumber` string	The phone number associated with the card, if the card is shared. Allowable values: A valid string
`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. Allowable values: <= 21 characters
`state` string (enum)	The state of the card. Allowable values: `ACTIVE`, `REPLACED`, `TERMINATED`, `SUSPENDED`, `UNACTIVATED`
`fulfillmentStatus` string (enum)	The fulfillment status of the card.. Allowable values: `ISSUED`, `ORDERED`, `REORDERED`, `REJECTED`, `SHIPPED`, `DIGITALLY_PRESENTED`

Response

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

Sample responseResponse structure

Copy

Copied

{
  "id": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
  "personId": "775596ae-2624-40af-a9dc-9756110a4a08",
  "accountId": "F12345",
  "cardProductName": "string",
  "lastFour": "0056",
  "expiration": "0111",
  "expirationTime": "2025-01-31T23:59:59Z",
  "pinIsSet": true,
  "state": "ACTIVE",
  "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.

Update a card's state

Post/v2/cards/{cardId}/transition

Request

Use this request to update the state of an existing card. For example, you can set the state of a lost card to SUSPENDED to prevent any unauthorised transactions. Later, if the card is later found, you can set the state to ACTIVE so that it can be used again. Learn more about card states.

Sample requestRequest structure

Copy

Copied

curl -i -X POST \
  'https://api.equalsmoney.com/v2/cards/e9293471-5eb3-4dbc-916c-dbaf9e2deefd/transition?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "state": "SUSPENDED",
    "reason": "Lost card"
  }'

Copy

Copied

curl -i -X POST \
  'https://api.equalsmoney.com/v2/cards/{cardId}/transition?accountId={accountId}' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "state": "string",
    "reason": "string"
  }'

Path parameters

Parameter	Description
`cardId` string required	The ID of the card that you want to update. Allowable values: An existing `cardId` (<= 36 characters)

Query parameters

Parameter	Description
`accountId` string required	The ID of the account associated with the card. Allowable values: An existing `cardId` (<= 36 characters)
`personId` string	The ID of the person who owns the card. Allowable values: An existing `personId` (<= 36 characters)

Request body schema

Parameter	Description
`state` string required	The state that you want to update the card to. Allowable values: `ACTIVE`, `TERMINATED`, `SUSPENDED`
`reason` string	The reason for the update. Allowable values: A valid string.

Response

If your request is successful, you'll receive a 200 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": "ACTIVE",
  "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.

Remove a card from a budget

Delete/v2/cards/{cardId}/budgets/{budgetId}

Request

Use this request to remove a card from a given budget.

Sample requestRequest structure

Copy

Copied

curl -i -X DELETE \
  'https://api.equalsmoney.com/v2/cards/755ab16f-bcb2-428c-ad22-2be6c24a5e3e/budgets/3135d763-551c-4289-b002-ea812bbd0d71?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

Copy

Copied

curl -i -X DELETE \
  'https://api.equalsmoney.com/v2/cards/{cardId}/budgets/{budgetId}?accountId={accountId}' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

Path parameters

Parameter	Description
`cardId` string required	The ID of the card to work with. Allowable values: An existing `accountId`
`budgetId` string required	The ID of the budget to remove the card from. Allowable values: An existing `budgetId`

Query parameters

Parameter	Description
`accountId` string required	The ID of the account associated with the card. Allowable values: An existing `accountId`

Response

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

Copy

Copied

{
  "success": true
}

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

Remove a card from all budgets

Delete/v2/cards/{cardId}/budgets

Request

Use this request to remove a card from all of the budgets that it's associated with.

Sample requestRequest structure

Copy

Copied

curl -i -X DELETE \
  'https://api.equalsmoney.com/v2/cards/755ab16f-bcb2-428c-ad22-2be6c24a5e3e/budgets?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

Copy

Copied

curl -i -X DELETE \
  'https://api.equalsmoney.com/v2/cards/{cardId}/budgets?accountId={accountId}' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE'

Path parameters

Parameter	Description
`cardId` string required	The ID of the card to work with. Allowable values: An existing `cardId`

Query parameters

Parameter	Description
`accountId` string required	The ID of the account associated with the card. Allowable values: An existing `accountId`

Response

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

Copy

Copied

{
  "success": true
}

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