List payees

Request

Request header:

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

Params:

offset:

• Type: number

page_count:

• Type: number

purpose:

• Type: string
• Value: rent | salary | invoice

search_keyword:

• Type: string

from:

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

to:

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

Response

Response body:

{
  "data": [
    {
      "account_number": "100000000000000",
      "amount": 300,
      "bank": 6,
      "comments": "Test",
      "country_id": 1,
      "currency_id": 1,
      "data": {
        "postal_code": "1234",
        "address": "Test",
        "supporting_documents": [
          "tenancy_agreement__1677834720__4712__aXBheW15LnBuZw=="
        ],
        "recipient_contact_name": "",
        "recipient_email": "",
        "recipient_mobile": "",
        "registration_number": "",
        "id_type": "sg_postal",
        "id_number": "%!s(*string=0xc00027dd80)__awd",
        "supplier_opt_in": null,
        "bank_country_id": 1,
        "first_name": null,
        "last_name": null,
        "bank_raw_name": "Bank of China",
        "bank_account_holder_name": null,
        "bank_raw_swift_code": "BKCHSGSGXXX",
        "unit_number": "awd",
        "files": [
          {
            "key": "tenancy_agreement__1677834720__4712__aXBheW15LnBuZw==",
            "name": "ipaymy.png",
            "size": 4712,
            "url": "https://api-test.ipaymy.com/v2/files/tenancy_agreement__1677834720__4712__aXBheW15LnBuZw=="
          }
        ]
      },
      "id": 43447,
      "is_international": false,
      "name": "Test Crypto",
      "order": 0,
      "purpose_id": 1,
      "unsupported_message": ""
    },
    {
      "account_number": "100000000000000",
      "amount": 30000,
      "bank": 6,
      "comments": "test",
      "country_id": 1,
      "currency_id": 1,
      "data": {
        "postal_code": "123",
        "address": "Da Nang",
        "supporting_documents": [
          "tenancy_agreement__1669707755__4712__aXBheW15LnBuZw=="
        ],
        "recipient_contact_name": "",
        "recipient_email": "",
        "recipient_mobile": "",
        "registration_number": "",
        "id_type": "sg_postal",
        "id_number": "123__123",
        "supplier_opt_in": null,
        "bank_country_id": 1,
        "first_name": null,
        "last_name": null,
        "bank_raw_name": "Bank of China",
        "bank_account_holder_name": null,
        "bank_raw_swift_code": "BKCHSGSGXXX",
        "unit_number": "123",
        "files": [
          {
            "key": "tenancy_agreement__1669707755__4712__aXBheW15LnBuZw==",
            "name": "ipaymy.png",
            "size": 4712,
            "url": "https://api-test.ipaymy.com/v2/files/tenancy_agreement__1669707755__4712__aXBheW15LnBuZw=="
          }
        ]
      },
      "id": 43127,
      "is_international": false,
      "name": "Test User",
      "order": 1,
      "purpose_id": 1,
      "unsupported_message": ""
    }
  ],
  "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.