List payers

Request

Request header:

GET https://api.ipaymy.com/v2/payment_collections/payers
Host: api.ipaymy.com
Accept: application/json
Authorization: Bearer your_access_token

Params:

offset:

• Type: number

page_count:

• Type: number

search_keyword:

• Type: string

to_create_or_upload_invoice:

• Type: string
• Value: y | n

o_created_at:

• Type: string
• Value: asc | desc

tag:

• Type: string
• Value: vip | active | new | risky

punctual:

• Type: string
• Value: most_punctual | least_punctual

from:

• Type: time
• Example: 2023-01-01T00:00:00.000Z

to:

• Type: time
• Example: 2024-01-01T00:00:00.000Z

Response

Response body:

{
  "data": [
    {
      "id": 1663,
      "user_id": 0,
      "email": "vien.sg.0013@mailinator.com",
      "first_name": "Test",
      "last_name": "User 2",
      "mobile_country_id": 1,
      "mobile_number": "80140302",
      "phone_country_id": 1,
      "phone_number": "",
      "registration_number": "",
      "company_name": "",
      "account_id": 0,
      "address_line_1": "",
      "address_line_2": "",
      "tags": ["new", "risky"],
      "created_by": 0,
      "payer_data": {
        "primary_communication_method": "email"
      },
      "review_status": null
    },
    {
      "id": 1661,
      "user_id": 0,
      "email": "",
      "first_name": "Test",
      "last_name": "",
      "mobile_country_id": 10,
      "mobile_number": "345412907",
      "phone_country_id": 1,
      "phone_number": "",
      "registration_number": "",
      "company_name": "",
      "account_id": 0,
      "address_line_1": "",
      "address_line_2": "",
      "tags": ["new", "risky"],
      "created_by": 0,
      "payer_data": {
        "primary_communication_method": "mobile_number"
      },
      "review_status": null
    }
  ],
  "total": 2
}

Response codes:

• 200: Good stuff, and the response body should be easy to parse.
• 422: Typically malformed JSON, such as an integer in place of the required alphanumeric string, or a missing key. Check the response body for further details.