Search Cards by Program Manager

The Search Cards by Program Manager endpoint enables you to search for specific cardholder details for customers in your program.

The GET endpoint can contain various options in which you can filter cardholder information. You can use the following options to search by:

  • publicToken
  • productId
  • productName
  • cardStatusCode
  • firstName
  • lastName
  • email
  • mobile
  • postCode
  • city
  • addressLine1
  • dateOfBirth
  • customerReference

In the below, a first name and last name have been added to the endpoint to search for cards belonging to cardholders with the name John Smith:

{{base-url}}/program-manager/search?FirstName=John&LastName=Smith

This will return a 200 response that will return the details of all cards for a cardholder with that name.

[
  {
    "publicToken": 123456789,
    "title": "Mr",
    "firstName": "John",
    "lastName": "Smith",
    "email": "[email protected]",
    "tel": "01234123456",
    "mobile": "07123123456",
    "dateOfBirth": "1982-11-03",
    "postCode": "S11 7AA",
    "city": "Sheffield",
    "addressLine1": "1 Sheffield Road",
    "customerReference": "ABCDEF123",
    "expiryDate": "2026-12",
    "currencyCode": "GBP",
    "availableBalance": 1000,
    "actualBalance": 1000,
    "CardStatus": "Active",
    "isLive": true,
    "cardType": "Physical",
    "productId": 10000,
    "productName": "Thredd Ltd",
    "schemeId": 0,
    "schemeName": "Thredd"
  }
]

👍

API Explorer

See the Get Cardholder Details for Program endpoint.