# List Payment Cards v2.0Beta

The List Payment Cards endpoint retrieves a list of payment cards for a customer from our payment processor. These are cards the customer has previously saved against their profile. All the cards linked to the customer profile will be returned.

The response will include cards that have expired and will return an empty array if the customer has not added any cards to their profile.

# Request

GET /v2.0/customers/{profileKey}/payments/cards

# Authorization

An OAuth 2.0 Bearer token with the Payment.Read scope is required. For more information, see Authentication.

# Path Parameters

A list of the supported path parameters is described below.

Name	Required	Type	Description
profileKey	true	guid	The profile key for the customer. This value can be retrieved from the `profileKey` claim in the token returned from our SSO solution.

# Response

200

Returns a PaymentCard resource wrapped in an ApiListResponse envelope.

# Response Body

The endpoint returns our ApiListResponse envelope. The data property of the response will contain an array of PaymentCard resources.

# Sample

{
  "message": "The operation succeeded!",
  "notifications": [],
  "numberOfRecords": 2,
  "totalRecords": 0,
  "data": [
    {
      "cardId": "5e5edd8a-ff4b-44b7-9239-500f456471e8",
      "instrumentType": "Bank Card",
      "cardHolderName": "Mr C Holder",
      "label": "My FNB Fusion Card",
      "acceptanceBrand": "Visa",
      "last4Digits": "0002",
      "status": "Active",
      "createdOn": "2020-07-13T00:00:00"
    },
    {
      "cardId": "a8411bcb-b44e-4156-818e-419744aa17ca",
      "instrumentType": "Bank Card",
      "cardHolderName": "Mr C Holder",
      "label": "Business ABSA Card",
      "acceptanceBrand": "Visa",
      "last4Digits": "4578",
      "status": "Expired",
      "createdOn": "2021-12-02T00:00:00"
    }
  ]
}

# Errors

The standard error responses apply.

401

Unauthorized

When authentication fails.

403

Forbidden

When authorisation fails.

404

Not Found

When the customer profile cannot be found.

← Resources Add Payment Card →