FIfinmo
Payin

Retrieve Payin

Changed on

Retrieve details of a specific payment using the Payin reference ID(Payin_*).

get/payin/{payin_id}

Request

  • Base URL
    https://api.finmo.net/v1
  • Auth
    HTTP basic

Path parameters

payin_idstring required
Example:payin_3b48f7a5bfc84f00835f6bb6ced2ee73

Payin reference (payin_*)

Response

request_idstring
request_timestring date-time
status_codeinteger
status_textstring
successboolean

Example response

{
  "data": {
    "additional_data": {},
    "advanced_redirect_url": null,
    "amount": 22,
    "cancelled_at": null,
    "checkout_id": null,
    "created_at": "2022-03-20T08:25:06.435Z",
    "credit_wallet_id": "wallet_031fdbb28534493585e2bdea5a14d846",
    "credit_wallet_transaction_id": null,
    "currency": "AUD",
    "customer_id": null,
    "description": "22 AUD @ Ecommerce Store",
    "expire_at": "2022-03-22T08:25:06.000Z",
    "expired_at": null,
    "fees_currency": null,
    "fees_including_tax": null,
    "fees_wallet_id": "wallet_4692ca2a66744525bc1cc1693963441e",
    "fees_wallet_transaction_id": null,
    "fees_without_tax": null,
    "is_cancellable": true,
    "is_chargeable": true,
    "is_completely_refunded": false,
    "is_fees_charged": false,
    "is_multiple_refund_allowed": false,
    "is_over_refundable": false,
    "is_paid": false,
    "is_partially_paid": false,
    "is_partially_refundable": true,
    "is_reconciled": false,
    "is_refund_initiated": false,
    "is_refundable": true,
    "metadata": {
      "any-custom-ref": "INV_123"
    },
    "org_id": "org_f2476ddbf1654dac95db965d697e24d6",
    "organization_reference_id": null,
    "paid_amount": null,
    "paid_at": null,
    "paid_currency": null,
    "pay_code": {
      "text": "payid_ref@finmo.net"
    },
    "payin_id": "payin_3b48f7a5bfc84f00835f6bb6ced2ee73",
    "payin_method_category": "BANK",
    "payin_method_description": "New Payments Platform (NPP)",
    "payin_method_name": "au_bank_npp",
    "payin_method_param": {
      "payid_reference": "payid_ref"
    },
    "payin_type": "DIRECT_PAYIN",
    "receipt_email": "test@email.com",
    "redirect_url": null,
    "refund_amount_completed": null,
    "refund_amount_requested": null,
    "refund_currency_completed": null,
    "refund_currency_requested": null,
    "refund_status": null,
    "sender_party_detail": null,
    "status": "PENDING",
    "tax_on_fees": null,
    "transaction_id": null,
    "updated_at": "2022-03-20T08:25:06.503Z",
    "virtual_account_id": null,
    "webhook_url": null
  },
  "request_id": "79e527eac00e4143afb186a14d990631",
  "request_time": "2022-03-20T08:29:27.555Z",
  "status_code": 200,
  "status_text": "OK",
  "success": true
}

Changes