Get schedule detail

Request

Request header:

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

Path Parameters:

schedule_id:

• Description: Unique schedule id from your list schedules
• Type: number

Response

Response body:

{
  "data": {
    "payments": [
      {
        "id": 93891,
        "scheduled_charge_date": "2023-04-21T08:51:32.500588Z",
        "payout_date": "2023-04-25T00:00:00Z",
        "cards": [
          {
            "id": 16872,
            "token": "",
            "statement_descriptor": "ipaymy *Vien Nguyen",
            "amount": 30525,
            "expiry_month": "",
            "expiry_year": "",
            "last_4": "",
            "card_brand": 0,
            "src_id": "wpss_215f9570-30f9-4bd8-81c7-745a57971f90",
            "src_id_type": "",
            "src_client_secrete": "",
            "stripe_account": "",
            "authorized_amount": null,
            "src_created_on_stripe_account": null,
            "three_ds_transaction_id": "MK92CFBKrzC03DOwbMk0",
            "card_holder_name": ""
          }
        ],
        "default_comments": "test",
        "payment_fee": 525,
        "payment_total": 30525,
        "payment_amount": 30000,
        "editable": false,
        "payment_status_id": 4,
        "is_amex_mcc": false,
        "payees": [
          {
            "id": 43127,
            "id_destination": "",
            "bank_id": 6,
            "bank_country_id": 0,
            "currency_id": 1,
            "country_id": 1,
            "account_number": "100000000000000",
            "recipient_name": "Vien Nguyen",
            "comments": "test",
            "amount": 30000,
            "refunded_amount": 0
          }
        ],
        "payment_flash_pay_fees": null,
        "payment_gst_fees": null
      },
      {
        "id": 93892,
        "scheduled_charge_date": "2023-06-19T21:15:31.227213Z",
        "payout_date": "2023-06-21T00:00:00Z",
        "cards": [
          {
            "id": 16872,
            "token": "",
            "statement_descriptor": "ipaymy *Vien Nguyen",
            "amount": 30537,
            "expiry_month": "",
            "expiry_year": "",
            "last_4": "",
            "card_brand": 0,
            "src_id": "wpss_215f9570-30f9-4bd8-81c7-745a57971f90",
            "src_id_type": "",
            "src_client_secrete": "",
            "stripe_account": "",
            "authorized_amount": null,
            "src_created_on_stripe_account": null,
            "three_ds_transaction_id": "MK92CFBKrzC03DOwbMk0",
            "card_holder_name": ""
          }
        ],
        "default_comments": "test",
        "payment_fee": 537,
        "payment_total": 30537,
        "payment_amount": 30000,
        "editable": false,
        "payment_status_id": 5,
        "is_amex_mcc": 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
          }
        ],
        "payment_flash_pay_fees": null,
        "payment_gst_fees": null
      }
    ],
    "schedule": {
      "id": 56793,
      "start_date": "2023-04-25T00:00:00Z",
      "end_date": "2024-01-25T00:00:00Z",
      "frequency": "1 mon",
      "scheduled_charge_date": null,
      "is_active": true,
      "payment_setting": {
        "purpose_id": 1,
        "currency_id": 1,
        "payment_amount": 30000,
        "payment_fees": 537,
        "payment_total": 30537,
        "payees": [
          {
            "id": 43127,
            "bank_id": 6,
            "bank_bsb_id": null,
            "currency_id": 1,
            "account_number": "100000000000000",
            "recipient_name": "Vien Nguyen",
            "comments": "test",
            "amount": 30000,
            "data": {
              "address": "Da Nang",
              "id_type": "sg_postal",
              "postal_code": "123",
              "company_name": "",
              "recipient_email": "",
              "registration_number": "",
              "supporting_documents": [
                "tenancy_agreement__1669707755__4712__aXBheW15LnBuZw=="
              ]
            },
            "refunded_amount": 0,
            "uid": "",
            "due_date": null,
            "payment_description": null,
            "fee_payer": null,
            "int_fee_payer": null,
            "requester_national_rate": null,
            "requester_oversea_rate": null,
            "requester_rate": null,
            "gross_amount": null
          }
        ],
        "cards": [
          {
            "id": 16872,
            "token": "",
            "statement_descriptor": "ipaymy *Vien Nguyen",
            "amount": 30537,
            "expiry_month": "",
            "expiry_year": "",
            "last_4": "",
            "card_brand": 0,
            "src_id": "wpss_215f9570-30f9-4bd8-81c7-745a57971f90",
            "src_id_type": "",
            "src_client_secrete": "",
            "stripe_account": "",
            "authorized_amount": null,
            "src_created_on_stripe_account": null,
            "three_ds_transaction_id": "MK92CFBKrzC03DOwbMk0",
            "card_holder_name": ""
          }
        ],
        "supporting_documents": {
          "43127": []
        },
        "payment_request_id": null,
        "statement_descriptor": "ipaymy *Vien Nguyen",
        "coupon": "",
        "is_wp_mcc": false,
        "is_amex_mcc": false
      },
      "upcoming_payout": "2023-07-21T00:00:00Z",
      "last_payout": "2023-06-23T00:00:00Z"
    }
  },
  "error": 0
}

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.