List payments

Request

Request header:

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

Params:

offset:

• Type: number

page_count:

• Type: number

is_favourite:

• Type: boolean
• Value: true | false

purpose:

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

statuses:

• Type: list number
• Example: 3,4

frequency:

• Type: string
• Value: one-time | recurring

search_keyword:

• Type: string

charge_date_lower:

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

charge_date_upper:

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

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": 94707,
      "created_at": "2023-07-11T09:30:02.042202Z",
      "updated_at": "2023-07-11T09:30:13.655149Z",
      "purpose_id": 3,
      "schedule_id": 57418,
      "currency_id": 1,
      "payment_amount": 30000,
      "payment_total": 30675,
      "payment_fees": 675,
      "payout_date": "2023-07-13T00:00:00Z",
      "cards": [
        {
          "id": 17057,
          "statement_descriptor": "ipaymy *ALLERTRON INNO",
          "amount": 30675,
          "last_4": "1091",
          "card_brand_id": 2
        }
      ],
      "card_charges": [
        {
          "receipt_number": "34596-94707",
          "charge_date": "2023-07-11 09:30:14.873921348 +0000 UTC",
          "amount": 30675,
          "refunded_amount": 0,
          "refunded_fee": 0,
          "refuse_reason": null,
          "refuse_reason_code": "",
          "refunded_date": ""
        }
      ],
      "payment_status_id": 3,
      "payment_request_id": null,
      "scheduled_charge_date": "2023-07-11T09:30:14.873921Z",
      "schedule_frequency": "",
      "coupon_code": "",
      "receipt_number": "34596-94707",
      "schedule_start_date": "2023-07-13T00:00:00Z",
      "schedule_end_date": "2023-07-13T00:00:00Z",
      "channel_fees": null,
      "exchange_rate": null,
      "rate": null,
      "amount_off": null,
      "paid_out_batch_id": null,
      "payer": null,
      "supporting_documents": [
        {
          "key": "invoice__1689067799__4712__aXBheW15LnBuZw==",
          "name": "ipaymy.png",
          "size": 4712,
          "url": "https://api-test.ipaymy.com/v2/files/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY2NvdW50X2lkIjozNDU5NiwiYXBwX2lkIjoiZmV0Y2giLCJmaWxlX2tleSI6Imludm9pY2VfXzE2ODkwNjc3OTlfXzQ3MTJfX2FYQmhlVzE1TG5CdVp3PT0ifQ.cgrFxzV9RpZxwtUKtsxdPngJADcsr8-p8rYGT6pavR8/public"
        }
      ],
      "payees": [
        {
          "id": 43506,
          "bank_id": 1,
          "bank_country_id": 0,
          "currency_id": 1,
          "account_number": "100000000000000",
          "recipient_name": "ALLERTRON INNOVATIONS (PTE. LTD.)",
          "comments": "test",
          "amount": 30000,
          "data": {
            "address": "",
            "id_type": "",
            "postal_code": "",
            "company_name": "",
            "recipient_email": "",
            "registration_number": "",
            "supporting_documents": null,
            "unit_number": null,
            "id_number": null
          },
          "refunded_amount": 0,
          "uid": "",
          "due_date": null,
          "payment_description": null,
          "fee_payer": null,
          "int_fee_payer": null,
          "crypto_rate_payer": null,
          "requester_national_rate": null,
          "requester_oversea_rate": null,
          "requester_crypto_rate": null,
          "requester_rates": null,
          "fee_structure": null,
          "gross_amount": null,
          "bank_raw_name": null,
          "bank_account_holder_name": null,
          "bank_address": null,
          "invoice_date": null,
          "terms": null,
          "items": null,
          "po_number": null,
          "invoice_number_digits": null,
          "incentives": null,
          "to_create_or_upload_invoice": null,
          "calculate_method": null
        }
      ],
      "email_status": null,
      "sms_status": null,
      "is_sms_invoice": false,
      "pay_url": null,
      "order": 4,
      "invoice_note": "",
      "term_and_condition": "",
      "step": null,
      "app_id": "fetch",
      "is_international_payment": false,
      "metadata": null,
      "payment_method_type": "card",
      "crypto_payment_detail": {
        "id": 0,
        "exchange_rate": 0,
        "crypto_currency": "",
        "crypto_amount": 0,
        "status": "",
        "display_crypto_currency": ""
      }
    }
  ],
  "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.