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]
      • POSTCreate Payer Profile
      • GETGet Payer Profile
  • Reporting API
  • Verification API
Log in to the PayOS Dashboard
LogoLogo
Payers API [BETA]Payers

Get Payer Profile

GET
https://api.payos.money/v1/payers/:payerId
GET
/v1/payers/:payerId
$curl https://api.payos.money/v1/payers/payerId
1{
2 "payerId": "PAYER_abcdef123456",
3 "name": "Jane Doe",
4 "emailAddress": "jane.doe@example.com",
5 "mobileNumber": "+15559876",
6 "metadata": {
7 "additionalInfo": "Sample metadata"
8 }
9}
Retrieves a payer profile and associated payment methods. This call is essential for accessing a payer's stored information, which can be used to facilitate transactions or update the payer's details. It returns comprehensive data about the payer, including their stored payment methods.
Was this page helpful?
Previous

List Stored Payment Methods

Next
Built with

Path parameters

payerIdstringRequired
The unique identifier for the payer.

Response

Payer profile retrieved successfully.
payerIdstring
Unique identifier for the payer.
namestring
Full name of the payer.
emailAddressstringformat: "email"
Email address of the payer.
mobileNumberstring
Mobile number of the payer.
metadatamap from strings to strings
Additional metadata for the payer.

Errors

404
Not Found Error