Path parameters

• accountHolderId string Required

  The account holder ID to retrieve payment methods for. Can be either:

  • Internal ID format: aho_01JRZPRGFF4J2SZC3HMDBYEN2J (assigned by our system)
  • External ID format: usr_1757945457790 (assigned by your system)

Query parameters

• sorts string

  Comma-separated list of fields to sort by. Prefix with - for descending order. Available fields: id, type, currency, cardType, maskedCardNumber, cardExpDate, dateCreated

• page integer

  Page number to retrieve (starts at 1). For example, if you have 100 records with 10 per page, page 2 gives you records 11 to 20.

  Minimum value is 1. Default value is 1.

• pageSize integer

  Number of records per page. For example, if you have 100 records with 10 per page, page 2 gives you records 11 to 20.

  Minimum value is 1, maximum value is 100. Default value is 10.

Responses

• 200 application/json

  A successful paginated response containing account holder payment methods

  Hide response attributes Show response attributes object

  • totalCount integer Required

    Total number of payment methods that match the filter criteria

  • page integer Required

    The current page number (starts at 1)

  • pageSize integer Required

    Number of items per page

  • totalPages integer Required

    Total number of pages available

  • hasNextPage boolean Required

    True if there are more pages of results available

  • hasPreviousPage boolean Required

    True if there are previous pages of results available

  • items array[object] Required

    List of tokenized payment methods for the account holder

    Hide items attributes Show items attributes object

    • id string Required

      The tokenized payment method ID. Example format: pmt_tkn_01JRZPRGFF4J2SZC3HMDBYEN2J

    • type string Required

      Value is Token.

    • currency string Required

      Values are USD or CAD.

    • billingContact object

      Billing contact information associated with the payment method. Not returned on card present transactions or on refunds, captures, etc. of card present transactions.

      Hide billingContact attributes Show billingContact attributes object

      • name string
      • countryCode string
      • zipCode string
      • address string
      • state string
      • city string
    • cardType string Required

      Values are VISA, MASTERCARD, AMEX, or DISCOVER.

    • maskedCardNumber string Required

      Masked version of the card number for display purposes

    • cardExpDate string Required

      Card expiration date in MMYY format

• 401 application/json

  Unauthorized - Missing or invalid API key

  Hide response attributes Show response attributes object

  • code integer
  • status string
  • message string
  • traceId string
  • timestamp string(date-time)
  • errorDetails array[object]

    Represents a validation error that occurred during the request.

    Hide errorDetails attributes Show errorDetails attributes object

    • code number

      Error code

    • field string

      The field with the error

    • message string

      Error message

    • details string

      Additional details about the error

• 404 application/json

  Resource not found

  Hide response attributes Show response attributes object

  • code integer
  • status string
  • message string
  • traceId string
  • timestamp string(date-time)
  • errorDetails array[object]

    Represents a validation error that occurred during the request.

    Hide errorDetails attributes Show errorDetails attributes object

    • code number

      Error code

    • field string

      The field with the error

    • message string

      Error message

    • details string

      Additional details about the error