List payment collections

Request

Request header:

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

Params:

offset:

• Type: number

page_count:

• Type: number

purpose:

• Type: number
• Value: 4

has_draft:

• Type: string
• Value: y | n

statuses:

• Type: list number
• Example: 2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18

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

Response

Response body:

[
  {
    "id": 94700,
    "created_at": "2023-07-07T09:32:57.371664Z",
    "updated_at": "2023-07-07T09:33:40.510188Z",
    "purpose_id": 4,
    "schedule_id": 57411,
    "currency_id": 1,
    "payment_amount": 300,
    "payment_total": 303,
    "payment_fees": 3,
    "payout_date": "2023-07-10T00:00:00Z",
    "cards": [],
    "card_charges": [],
    "payment_status_id": 3,
    "payment_request_id": 7335,
    "scheduled_charge_date": "2023-07-07T09:32:57.402286Z",
    "schedule_frequency": "",
    "coupon_code": "",
    "receipt_number": "34596-94700",
    "schedule_start_date": "2023-07-07T00:00:00Z",
    "schedule_end_date": "2023-07-07T00:00:00Z",
    "channel_fees": null,
    "exchange_rate": null,
    "rate": null,
    "amount_off": null,
    "paid_out_batch_id": null,
    "payer": {
      "id": 1663,
      "first_name": "Test",
      "last_name": "User 2"
    },
    "supporting_documents": [
      {
        "key": "invoice__1688722366__4712__aXBheW15LnBuZw==",
        "name": "ipaymy.png",
        "size": 4712,
        "url": "https://api-test.ipaymy.com/v2/files/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY2NvdW50X2lkIjozNDU5NiwiYXBwX2lkIjoiZmV0Y2giLCJmaWxlX2tleSI6Imludm9pY2VfXzE2ODg3MjIzNjZfXzQ3MTJfX2FYQmhlVzE1TG5CdVp3PT0ifQ.BEJXcdBiMlxTvVfOugX2vM9BdBG3Ra4zx-ibqYhBzPs/public"
      }
    ],
    "payees": [
      {
        "id": 4739,
        "bank_id": 1,
        "bank_country_id": 0,
        "currency_id": 1,
        "account_number": "1000000000",
        "recipient_name": "TEKIO CONSULTANCY",
        "comments": "INV - 000088",
        "amount": 300,
        "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": "2023-07-07T09:32:34.718Z",
        "payment_description": "INV - 000088",
        "fee_payer": 0,
        "int_fee_payer": 0,
        "crypto_rate_payer": 0,
        "requester_national_rate": null,
        "requester_oversea_rate": null,
        "requester_crypto_rate": null,
        "requester_rates": [
          {
            "brand_id": 2,
            "national": 0,
            "international": 0,
            "fee_payer": 3,
            "int_fee_payer": 3,
            "crypto_rate": 0,
            "crypto_rate_payer": 0
          },
          {
            "brand_id": 5,
            "national": 0,
            "international": 0,
            "fee_payer": 3,
            "int_fee_payer": 3,
            "crypto_rate": 0,
            "crypto_rate_payer": 0
          },
          {
            "brand_id": 4,
            "national": 0,
            "international": 0,
            "fee_payer": 3,
            "int_fee_payer": 3,
            "crypto_rate": 0,
            "crypto_rate_payer": 0
          },
          {
            "brand_id": 0,
            "national": 0,
            "international": 0,
            "fee_payer": 0,
            "int_fee_payer": 0,
            "crypto_rate": 0,
            "crypto_rate_payer": 95
          }
        ],
        "fee_structure": {
          "customer_rate": 95,
          "customer_fee": 3,
          "requester_rate": 0,
          "requester_fee": 0,
          "is_national_card": false,
          "incentive_discount_fee": 0,
          "incentive_type_id": "",
          "incentive_rate": 0
        },
        "gross_amount": 300,
        "bank_raw_name": null,
        "bank_account_holder_name": null,
        "bank_address": null,
        "invoice_date": "2023-07-07T09:32:34.718Z",
        "terms": "Due On Receipt",
        "items": null,
        "po_number": null,
        "invoice_number_digits": 88,
        "incentives": null,
        "to_create_or_upload_invoice": "upload",
        "calculate_method": null
      }
    ],
    "email_status": null,
    "sms_status": null,
    "is_sms_invoice": false,
    "pay_url": "https://url-test.ipaymy.com/tekio-consultancy/ZZZ9gl6",
    "order": 1,
    "invoice_note": "",
    "term_and_condition": "",
    "step": 4,
    "app_id": "fetch",
    "is_international_payment": false,
    "metadata": null,
    "payment_method_type": "crypto",
    "crypto_payment_detail": {
      "id": 5,
      "exchange_rate": 40592.98,
      "crypto_currency": "testBTC",
      "crypto_amount": 0.00007464,
      "status": "good",
      "display_crypto_currency": "testBTC"
    }
  }
]

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.