Get Custom Card

Retrieve and use the Custom Card ID to request a custom card. How it works:

  • Call GET /programs/{programCode}/accounts/{accountIdentifier}/paymentInstruments/{paymentInstrumentIdentifier}
  • If a custom card is available, your response will contain the customCardImageIdentifier field, which is a unique identifier for the custom card.
  • Call GET /programs/{programCode}/userIdentifiers/{userIdentifier}/getCustomCard?customCardImageIdentifier=GUID
    • Search for the custom card you are looking for using the customCardImageIdentifier.
    • If the custom card is found, you will receive a response containing the custom card information.
    • If the custom card is not found, you will receive the following:
      • Code: 4
      • Subcode: 1024
      • Description: customCardImageIdentifier not found or not supplied.

Note: GET customCard can be called with or without the customCardImageIdentifier. Sample response: GET paymentInstrument element.

Language
Credentials
Header