Manage Payer Information

The Payiano's list payers endpoint provides a comprehensive overview of all payers. It's akin to a directory that lists every payer who has made or is designated to make a payment. This endpoint is crucial for partners or administrators who need to manage or review the individuals responsible for transactions. Through this endpoint, users can obtain a broad view, including basic information like names, email addresses, and phone numbers of all payers.

GET/cash_collection/payers
Sandbox: https://api-partner.payiano.dev/v1/cash_collection/payers
Live: https://api-partner.payiano.com/v1/cash_collection/payers
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
Query parameters:
page
Type: integer|null
Default: 1

The page number to be retrieved, for the list of payers. So, a combination of page=1 and per_page=25 returns the first 25 payers. A combination of page=2 and per_page=25 returns the next 25 payers.

per_page
Type: integer|null
Default: 25
Possible values: [1 ... 200]

The maximum number of payers to return in the response.

Response
200
Response schema:
application/json
Response body:
total_pages
Type: integer

The total number of pages that are available for the payers search criteria.

current_page
Type: integer

The current pagination page.

per_page
Type: integer

The amount of payers items return per page.

total_items
Type: integer

The total number of payers that match the search criteria.

items
Type: array_of_objects

The list of payers that match the search criteria.

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 "per_page": 25, 3 "total_pages": 1, 4 "total_items": 1, 5 "current_page": 1, 6
 "items": [ 7
 { 8 "id": "01hqpqw63s6jg9nq8m4fpddrmn", 9 "name": "Mohsen Ali", 10 "email": "mohsen@gawaab.com", 11 "phone_number": "+201000333000", 12 "created_at": "1722572118554", 13 "updated_at": "1722572118554" 14 } 15 ] 16}