Skip to main content
GET
/
v1
/
customers
/
{customerId}
Get a customer
curl --request GET \
  --url https://api.yuvexpay.com/v1/customers/{customerId} \
  --header 'Authorization: Bearer <token>'
{
  "customer": {
    "customerId": "<string>",
    "name": "<string>",
    "email": "<string>",
    "document": "<string>",
    "phone": "<string>",
    "externalId": "<string>",
    "isActive": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "metadata": {},
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

YuvexPay API key. Include as Authorization: Bearer ypk_<env>_<kid>_<secret> where <env> is test (sandbox) or live (production). Create and manage keys in the dashboard under Settings > API Keys.

Path Parameters

​
customerId
string
required

The customer's prefixed identifier (e.g., cus_ab12cd34ef). This is the merchant-facing slug, not the internal UUID.

Response

Customer found.

​
customer
object