Get Payment Credential

The Get Payment Credential endpoint enables you to retrieve a specific payment credential.

You can get a specific payment credential by making a GET request to the Get Payment Credential endpoint, where paymentCredentialId is the credential identifier you want to view all payment credentials for. For example:

{{base-url}}/v1/{paymentCredentialId}

If successful, a 200 response is returned with details of the payment credential. The type of response depends on thewe credential type. The below examples display the response for where the credential is a card type and where the credential is a bank type:

{
    "status": "success",
    "response": {
        "trackingId": "alias#-8a995901-20250602101655",
        "paymentCredentials": {
            "id": "88c1977e-ef85-4982-9fcc-01dffdb45d30",
            "nameOnCard": "John Doe",
            "issuerName": "Bank of America",
            "cardType": "VISA",
            "accountNumber": "411X********1142",
            "expirationDate": "2025-12",
            "currencyCode": "USD",
            "billingAddress": {
                "country": "USA",
                "addressLine1": "123 Main St",
                "addressLine2": "Apt 4B",
                "buildingNumber": "456",
                "city": "Los Angeles",
                "minorSubdivisionCode": "CA",
                "streetName": "Sunset Blvd",
                "postalCode": "90001",
                "state": "California"
            },
            "preferredFor": [
                {
                    "type": "SEND",
                    "date": "2025-05-30T16:18:25"
                }
            ],
            "accountNumberType": "PAN",
            "lastFourDigits": "1142",
            "status": "ACTIVE",
            "createdOn": "2025-05-30T09:59:03",
            "lastUpdatedOn": "2025-05-30T16:18:25",
            "type": "CARD",
            "externalId": ""
        }
    }
}

{
"status": "success",
"response": {
    "trackingId": "alias#-8a995901-20250602101655",
    "paymentCredentials": {
       "id": "a44c9553-e687-4f3c-b7e7-a4245d9f238e",
       "accountName": "Alex Miller",
       "type": "BANK",
       "accountNumberType": "TOKEN",
       "accountNumber": "4111111145551142",
       "address": {
         "city": "San Francisco",
         "state": "CA",
         "country": "USA",
         "postalCode": "94105",
         "streetName": "12",
         "addressLine1": "1000 Market Street",
         "addressLine2": "Suite 101",
         "buildingNumber": "56",
         "minorSubdivisionCode": "CA"
       },
       "expirationDate": "2026-01",
       "lastFourDigits": "1142",
       "externalId": "63421837-d597-4f0f-89e4-930c1a7b9e85",
       "preferredFor": [
         {
           "date": "2021-01-01T22:52:46Z",
           "type": "RECEIVE"
         }
       ],
       "bankName": "Bank A",
       "countryCode": "USA",
       "currencyCode": "USD",
       "status": "ACTIVE",
       "createdOn": "2021-06-21T13:00:00.645Z",
       "lastUpdatedOn": "2021-06-22T15:12:00.322Z"
  }

📘
More Information

To view this endpoint in the API Explorer, see Get Payment Credential.

To view descriptions for this endpoint, see Get Payment Credential - Field Descriptions.

Updated 11 days ago