v1

latestOpenAPI 3.0.12026-07-24128351404.9 KB
Cardholder

List Cardholders

get/open-api/v3/cardholders

Query parameters

accountIdstring uuid required

The UUID of the Account.

The UUID of the Account.

idstring

The Id of the Cardholder.

The Id of the Cardholder.

status'ACTIVE' | 'PENDING' | 'INACTIVE'

The status of the Cardholder.

The status of the Cardholder.

emailstring

User’s email address. Example: user@example.com

User’s email address. Example: user@example.com

referenceIdstring

Unique identifier for referencing the associated request or resource.

Unique identifier for referencing the associated request or resource.

limitstring number

Limits the number of items to be returned.

Limits the number of items to be returned.

pagestring number

The page to be returned, counting from 1 as the first page.

The page to be returned, counting from 1 as the first page.

Response

OK

codestring

Error code

messagestring

Error message

Example response

{
  "code": "400001",
  "message": "Invalid parameter",
  "data": {
    "list": [
      {
        "address": {
          "addressLine1": "123 Main St",
          "addressLine2": "Apt 4B",
          "city": "New York",
          "country": "US",
          "postalCode": "10001"
        }
      }
    ]
  }
}