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

Add Stored Payment Method

POST
https://api.payos.money/v1/payers/:payerId/paymentMethods
POST
/v1/payers/:payerId/paymentMethods
$curl -X POST https://api.payos.money/v1/payers/payerId/paymentMethods \
>     -H "Content-Type: application/json" \
>     -d '{
>  "type": "debitCard",
>  "encryptedPan": "string",
>  "encryptedCvv": "string"
>}'
1{
2  "paymentMethodToken": "string",
3  "type": "string",
4  "identifier": "string",
5  "lastUsed": "2024-01-15T09:30:00Z",
6  "createdAt": "2024-01-15T09:30:00Z",
7  "cardBrand": "string",
8  "lastFourDigits": "string"
9}
Adds a new stored payment method to an existing payer profile. This call allows businesses to expand the payment options available to a payer, facilitating future transactions by storing necessary payment details securely.
Was this page helpful?
Previous

Delete Stored Payment Method

Next
Built with

Path parameters

payerIdstringRequired
The unique identifier for the payer.

Request

This endpoint expects an object.
objectRequired
OR
objectRequired
OR
objectRequired
OR
objectRequired

Response

Stored payment method added 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

400
Bad Request Error