List schedules compact

Request

Request header:

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

Params:

offset:

• Type: number

page_count:

• Type: number

purpose:

• Type: list number
• Example: 1,3,5

is_active:

• Type: string
• Example: y | n

frequency:

• Type: string
• Value: weekly | biweekly | monthly | quarterly | biannually

search_keyword:

• Type: string

payout_date_lower:

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

payout_date_upper:

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

Response

Response body:

{
  "data": [
    {
      "id": 56793,
      "purpose_id": 1,
      "frequency": "1 mon",
      "start_date": "2023-04-25T00:00:00Z",
      "end_date": "2024-01-25T00:00:00Z",
      "cards": [
        {
          "id": 16872,
          "last_4": "1091",
          "card_brand_id": 2,
          "card_brand_logo_url": "https://s3-ap-southeast-1.amazonaws.com/ipaymy.com/img/email/visa.png",
          "statement_descriptor": "",
          "additional_data": {
            "is_favourite": false,
            "card_nick_name": "Test WP"
          }
        }
      ],
      "payment_amount": 30000,
      "payment_fees": 537,
      "payment_total": 30537,
      "is_cancelled": false,
      "payees": [
        {
          "id": 43127,
          "id_destination": "",
          "bank_id": 6,
          "bank_country_id": 0,
          "currency_id": 1,
          "country_id": null,
          "account_number": "100000000000000",
          "recipient_name": "Vien Nguyen",
          "comments": "test",
          "amount": 30000,
          "refunded_amount": 0,
          "uid": ""
        }
      ],
      "has_special_rate": false
    }
  ],
  "total": 1
}

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.