Documentation
thredd.comDocumentation Portal
Start typing to search…

Get All Payment Credentials

The Get All Payment Credentials endpoint enables you to retrieve all Payment Credentials for an existing Alias.

You can get all payment credentials by making a GET request to the Get All Payment Credentials endpoint, where aliasId is the alias you want to view all payment credentials for. For example:

{{base-url}}/ads/api/v1/aliases/{aliasId}/paymentCredentials

If successful, a 200 response is returned with information on all aliases. See the below example of a successful response.

{
  "status": "success",
  "response": {
    "trackingId": "alias#-c1185292-20250528122428",
    "paymentCredentialsAll": [
      {
        "cardInfoAll": [
          {
            "id": "88703d56-872f-4fb9-abba-9721479eb624",
            "nameOnCard": "John Doe",
            "issuerName": "Bank A",
            "cardType": "Visa Platinum",
            "accountNumber": "411X********1142",
            "expirationDate": "2030-01",
            "externalId": "63421837-d597-4f0f-89e4-930c1a7b9u82",
            "currencyCode": "USD",
            "billingAddress": {
              "country": "USA",
              "addressLine1": "1000 Market Street",
              "addressLine2": "Suite 101",
              "buildingNumber": "56",
              "city": "San Francisco",
              "minorSubdivisionCode": "CA",
              "postalCode": "94105",
              "state": "CA",
              "streetName": "12"
            },
            "preferredFor": [
              {
                "type": "RECEIVE",
                "date": "2021-01-01T22:52:46Z"
              }
            ],
            "accountNumberType": "PAN",
            "lastFourDigits": "1142",
            "status": "ACTIVE",
            "createdOn": "2021-06-21T13:00:00.645Z",
            "lastUpdatedOn": "2021-06-22T15:12:00.322Z",
            "type": "CARD"
          }
        ],
        "bankInfoAll": [
          {
            "id": "e122cfde-9fe2-4e56-abbf-2d4c6e4a7d96",
            "accountName": "John Doe",
            "accountNumber": "411X********1142",
            "accountNumberType": "IBAN",
            "accountType": "CHECKING",
            "bankName": "JPMorgan Chase Bank",
            "bankCode": "021000021",
            "bankCodeType": "ABA",
            "bic": "AAAABBCC123",
            "countryCode": "USA",
            "currencyCode": "USD",
            "externalId": "63421837-d597-4f0f-89e4-930c1a7b9e85",
            "branchCode": "123456",
            "address": {
              "country": "USA",
              "addressLine1": "1000 Market Street",
              "addressLine2": "Suite 101",
              "buildingNumber": "56",
              "city": "San Francisco",
              "minorSubdivisionCode": "CA",
              "postalCode": "94105",
              "state": "CA",
              "streetName": "12"
            },
            "type": "BANK",
            "status": "ACTIVE",
            "createdOn": "05/28/2025 11:46:29",
            "lastUpdatedOn": "2021-06-22T15:12:00.322Z",
            "preferredFor": [
              {
                "type": "RECEIVE",
                "date": "2021-01-01T22:52:46Z"
              }
            ]
          }
        ]
      }
    ]
  }
}

📘

More Information

Updated 11 days ago