Access Detailed Payer Profile

The Payiano's retrieve payer endpoint focuses on fetching detailed information about a specific payer. It's similar to selecting a contact in your phone book and viewing all their details. By using this endpoint, one can access a particular payer’s complete profile, including their name, email, and phone number. This detailed view is particularly useful for addressing individual queries, or conducting targeted communication.

GET/cash_collection/payers/{id}
Sandbox: https://api-partner.payiano.dev/v1/cash_collection/payers/{id}
Live: https://api-partner.payiano.com/v1/cash_collection/payers/{id}
Security
  • Authorization header with access token is required to access this endpoint: Bearer ACCESS-TOKEN
  • Your access token should be associated to this permission cash_collection_payers_view
Request
Request body schema:
application/json
Path parameters:
id
required
Type: ulid
Length: 26

The unique ID assigned to each payer which is generated by our system using the ULID format. Each ID is precisely 26 characters long, ensuring a unique and consistent identifier for every payer. This ULID is automatically created by our system and is used to uniquely identify and track each payer in our database.

Response
200
Response schema:
application/json
Response body:
payer
Type: object

The payer model details.

id
Type: ulid
Length: 26

The unique ID assigned to each payer which is generated by our system using the ULID format. Each ID is precisely 26 characters long, ensuring a unique and consistent identifier for every payer. This ULID is automatically created by our system and is used to uniquely identify and track each payer in our database.

name
Type: string
Min: 2
Max: 100

This is the fundamental attribute representing the payer's full legal or preferred name. It's used in all forms of communication and identification. It's crucial for personalization and ensures that all correspondences and documents are correctly addressed.

email
Type: string
Min: 5
Max: 255

The email address is a key point of contact for digital communication. It's used for sending transactional emails, marketing material and support communications.

phone_number
Type: string

This attribute stores the payer's mobile number. It's essential for direct contact, SMS notifications, and can also be used in cases where email communication is insufficient or inappropriate.

created_at
Type: datetime

The created datetime of the payer. This attribute can be formatted as an ISO 8601 string or a UNIX timestamp in milliseconds, depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or 1722572118554). By default, the format is UNIX timestamp in milliseconds.

updated_at
Type: datetime

The updated datetime of the payer. This attribute can be formatted as an ISO 8601 string or a UNIX timestamp in milliseconds, depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or 1722572118554). By default, the format is UNIX timestamp in milliseconds.

Response sample:
1
{ 2
 "payer": { 3 "id": "01hqpqw63s6jg9nq8m4fpddrmn", 4 "name": "Mohsen Ali", 5 "email": "mohsen@gawaab.com", 6 "phone_number": "+201000333000", 7 "created_at": "1722572118554", 8 "updated_at": "1722572118554" 9 } 10}