EQequalsmoney
Card details

List cards

Returns a list of cards on an account, ordered in alphabetical order by card name.

get/cards

Request

Query parameters

accountIdstring required

The ID of the account to work with.

Example:F50091
'digitalWalletSettings'
OR
string[]
'ACTIVE' | 'REPLACED' | 'TERMINATED' | 'SUSPENDED' | 'UNACTIVATED'
OR
string[] 
[
  "ACTIVE"
]
orderBy'asc' | 'desc'

The order in which to return results. By default, cards are sorted by name in ascending order.

startDatestring

The earliest date from which to retrieve records (includes records on this date).

Example:2020-01-01
endDatestring

The latest date until which to retrieve records (includes records on this date).

Example:2020-01-01
searchstring

The term to search the records for.

Example:Cesar+Treutel
budgetIdstring uuid

The ID of the budget to work with.

Example:775596ae-2624-40af-a9dc-9756110a4a03
cardIdstring uuid

The ID of the card to work with.

Example:e9293471-5eb3-4dbc-916c-dbaf9e2deefd
string
OR
string[]
cardOwnerType'PEOPLE' | 'BUDGET'

The card owner type of the card.

Example:PEOPLE
'VIRTUAL_PAN' | 'PHYSICAL_MSR' | 'PHYSICAL_COMBO'
OR
string[] 
[
  "PHYSICAL_MSR"
]
personIdstring uuid

The ID of the person to work with.

Example:775596ae-2624-40af-a9dc-9756110a4a04
string
OR
string[]
limitinteger

The maximum number of results to return.

Example:200
offsetinteger

The number of items to skip before returning results.

Example:100

Response

OK

limitinteger

The maximum number of results to return.

offsetinteger

The number of items to skip before returning results.

countinteger

The total amount of records matching the querying when "limit" is ignored.

searchstring

The term to search the records for.

Example response

{
  "limit": 200,
  "offset": 100,
  "count": 67,
  "search": "Cesar+Treutel",
  "rows": [
    {
      "id": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
      "personId": "775596ae-2624-40af-a9dc-9756110a4a04",
      "accountId": "F50091",
      "lastFour": "0056",
      "expiration": "0111",
      "expirationTime": "2025-01-31T23:59:59Z",
      "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"
      },
      "name": "Team Party Card"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.