For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log in to the PayOS Dashboard
GuidesAPI ReferenceHelp Center
GuidesAPI ReferenceHelp Center
  • Authentication API
    • POSTRequest an Access Token
  • Payments API
  • Payment Rules API
  • Payouts API
  • Payers API [BETA]
      • GETList Stored Payment Methods
      • POSTAdd Stored Payment Method
      • DELDelete Stored Payment Method
  • Reporting API
  • Verification API
Log in to the PayOS Dashboard
LogoLogo
Payers API [BETA]Stored Payment Methods

List Stored Payment Methods

GET
https://api.payos.money/v1/payers/:payerId/paymentMethods
GET
/v1/payers/:payerId/paymentMethods
$curl https://api.payos.money/v1/payers/payerId/paymentMethods
1[
2  {
3    "paymentMethodToken": "string",
4    "type": "string",
5    "identifier": "string",
6    "lastUsed": "2024-01-15T09:30:00Z",
7    "createdAt": "2024-01-15T09:30:00Z",
8    "cardBrand": "string",
9    "lastFourDigits": "string"
10  }
11]
Retrieves all stored payment methods associated with a payer. This operation is crucial for reviewing the payment options available to a payer, enabling businesses to offer the most convenient payment method during a transaction.
Was this page helpful?
Previous

Add Stored Payment Method

Next
Built with

Path parameters

payerIdstringRequired
The unique identifier for the payer.

Response

Stored payment methods retrieved successfully.
paymentMethodTokenstring
Token representing the payment method.
typestring
Type of the payment method.
identifierstring

Identifier for the payment method (e.g., last 4 digits).

lastUsedstringformat: "date-time"
Timestamp of the last successful transaction.
createdAtstringformat: "date-time"
Timestamp when the payment method was added.

Errors

404
Not Found Error