List schedules

Request

Request header:

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

Params:

offset:

Type: number

page_count:

Type: number

is_active:

Type: time
Value: y | n

Response

Response body:

{
  "data": [
    {
      "id": 56793,
      "purpose_id": 1,
      "frequency": "Monthly",
      "start_date": "2023-04-25T00:00:00Z",
      "end_date": "2024-01-25T00:00:00Z",
      "cards": [
        {
          "id": 16872,
          "statement_descriptor": "ipaymy *Test User"
        }
      ],
      "payment_amount": 30000,
      "payment_fees": 525,
      "payment_total": 30525,
      "is_cancelled": false,
      "payees": [
        {
          "id": 43127,
          "id_destination": "",
          "bank_id": 6,
          "bank_country_id": 0,
          "currency_id": 1,
          "country_id": 1,
          "account_number": "100000000000000",
          "recipient_name": "Test User",
          "comments": "test",
          "amount": 30000,
          "refunded_amount": 0,
          "uid": ""
        }
      ],
      "schedule_status": "",
      "has_special_rate": true
    }
  ],
  "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.