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
    • POSTPost Api V 1 Disbursement Initiate
    • GETGet Api V 1 Disbursement Status
    • POSTPost Api V 1 Disbursement Retry
  • Payers API [BETA]
  • Reporting 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
1curl https://api.payos.money/v1/payers/payerId/paymentMethods
Try it
1[
2 {
3 "paymentMethodToken": "paymentMethodToken",
4 "type": "type",
5 "identifier": "identifier",
6 "lastUsed": "2024-01-15T09:30:00Z",
7 "createdAt": "2024-01-15T09:30:00Z"
8 }
9]
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
Add Stored Payment Method
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.

Path parameters

payerIdstringRequired
The unique identifier for the payer.

Response

Stored payment methods retrieved successfully.
paymentMethodTokenstring or null
Token representing the payment method.
typestring or null
Type of the payment method.
identifierstring or null
Identifier for the payment method (e.g., last 4 digits).
lastUseddatetime or nullDefaults to 1970-01-01T00:00:00.000Z
Timestamp of the last successful transaction.
createdAtdatetime or nullDefaults to 1970-01-01T00:00:00.000Z
Timestamp when the payment method was added.

Errors

Timestamp when the payment method was added.
The unique identifier for the payer.
Stored payment methods retrieved successfully.

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