GET
/
cards
{
  "status": "00",
  "message": "Cards retrieved successfully",
  "data": {
    "cards": [
      {
        "card_id": "1",
        "customer_id": "1",
        "product_id": "1",
        "account_number": "1234567890",
        "card_scheme": "VISA",
        "card_type": "VIRTUAL",
        "card_mode": "DEBIT",
        "card_status": "ACTIVE",
        "card_currency": "NGN",
        "card_holder_name": "John Doe",
        "card_number": "1234",
        "card_cvv2": "123",
        "card_default_pin": "1234",
        "card_token": "1234567890",
        "card_expiry": {
          "month": "01",
          "year": "<string>"
        },
        "card_address": {
          "street": "123 Main St",
          "city": "New York",
          "state": "NY",
          "country": "US"
        },
        "custom_properties": [
          {
            "id": "1",
            "description": "custom_property",
            "type": "string",
            "value": "custom_property"
          }
        ]
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

connection-id
string

Connection ID for the target bank

idempotency-key
string
required

Unique key to ensure idempotency of the request

signature
string
required

SHA-256 signature of client_secret + ";" + idempotency-key

Response

Cards retrieved successfully

status
string
required
Example:

"00"

message
string
required
Example:

"Cards retrieved successfully"

data
object
required
I