Get payment detail

Request

Request header:

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

Path Parameters:

reciept_number:

• Description: Unique receipt number from your list payments
• Type: number

Params:

with_schedule:

• Type: string
• Value: y | n

Response

Response body:

{
  "data": {
    "id": 94707,
    "created_at": "2023-07-11T09:30:02.042202Z",
    "updated_at": "0001-01-01T00:00:00Z",
    "purpose_id": 3,
    "schedule_id": 57418,
    "currency_id": 1,
    "payment_amount": 30000,
    "payment_fees": 675,
    "payment_total": 30675,
    "payout_date": "2023-07-13T00:00:00Z",
    "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": "uen",
          "postal_code": "",
          "company_name": "",
          "recipient_email": "vien22@ipaymy.com",
          "registration_number": "201600211W",
          "supporting_documents": [],
          "unit_number": "",
          "id_number": ""
        },
        "refunded_amount": 0
      }
    ],
    "cards": [
      {
        "id": 17057,
        "statement_descriptor": "ipaymy *ALLERTRON INNO",
        "amount": 30675,
        "last_4": "",
        "card_brand_id": 0
      }
    ],
    "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,
        "refunded_flash_pay_fee": null,
        "refuse_reason": null,
        "refuse_reason_code": "",
        "refunded_date": ""
      }
    ],
    "payment_status_id": 3,
    "scheduled_charge_date": "2023-07-11T09:30:14.873921Z",
    "schedule_start_date": "0001-01-01T00:00:00Z",
    "schedule_end_date": "0001-01-01T00:00:00Z",
    "schedule_frequency": "00:00:00",
    "coupon_code": "",
    "receipt_number": "34596-94707",
    "channel_fees": null,
    "exchange_rate": null,
    "rate": 225,
    "amount_off": null,
    "order": 0,
    "supporting_documents": null,
    "email_status": null,
    "sms_status": null,
    "is_sms_invoice": false,
    "pay_url": null,
    "payment_request_id": null,
    "completed_at": null,
    "schedule_payments": {
      "is_active": false,
      "frequency": "",
      "payments": [
        {
          "payout_date": "2023-07-13T00:00:00Z",
          "payment_status_id": 3,
          "id": 94707,
          "receipt_number": "34596-94707",
          "account_id": 34596,
          "cards": [
            {
              "id": 17057,
              "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": ""
              }
            }
          ],
          "payment_total": 30675,
          "editable": false,
          "created_by": 0,
          "app_id": "",
          "scheduled_charge_date": "2023-07-11T09:30:14.873921Z",
          "payment_amount": 0,
          "payment_fees": 0,
          "currency_id": 0,
          "purpose_id": 0,
          "rate": null,
          "payees": null,
          "IsLastPayment": false
        }
      ],
      "end_date": "2023-07-13T00:00:00Z"
    },
    "is_international_payment": false,
    "is_production_payment": false,
    "is_onscreening_payment": false,
    "is_amex_mcc": false,
    "payment_method_type": "card",
    "crypto_payment_detail": {
      "id": 0,
      "exchange_rate": 0,
      "crypto_currency": "",
      "crypto_amount": 0,
      "status": "",
      "display_crypto_currency": ""
    },
    "payment_flash_pay_fees": null,
    "payment_gst_fees": null
  },
  "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.