GET
/
consumers
/
{id}
Get consumer
curl --request GET \
  --url https://api.paygentic.io/v0/consumers/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "object": "consumer",
  "name": "<string>",
  "email": "jsmith@example.com",
  "address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "zipCode": "<string>"
  },
  "metadata": {},
  "phone": "<string>",
  "createdById": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

API key authentication

Path Parameters

id
string
required

Unique identifier for an organization

Response

Consumer details retrieved successfully

id
string
required

Unique identifier for an organization

object
enum<string>
required
Available options:
consumer
name
string
required
Maximum length: 100
email
string<email>
required
address
object
required
metadata
object
required
phone
string
required
createdById
string
required

The ID of the merchant who created this consumer (if created by a merchant). Empty string if not created by a merchant.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required