FIfinmo
Payin

List All Payins

Changed on

Retrieve a list of all Payin’s created. Use query parameters to filter the list.

This API comes with Pagination support, you can customize limit and page query parameters as per the requirements.

get/payin

Request

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

Query parameters

status'PENDING' | 'COMPLETED' | 'EXPIRED' | 'CANCELLED' | 'CREATED' | 'FAILED'
Example:PENDING

List transactions by Payin Status (PENDING, COMPLETED, EXPIRED, CANCELLED, CREATED & FAILED)

created_atstring date
Example:2022-03-20

YYYY-MM-DD (UTC date). If you wish to search based on local time then use start_time and end_time fields

customer_idstring
Example:customer_d324385aad334ed3b754873651956347

List transactions for a specific customer_id

credit_wallet_idstring
Example:wallet_205ece2c2069435a943102a50dab0cbc

List transactions for a specific wallet_id. If you don't provide the wallet_id, it will fetch all transaction from the Organization Payin wallet

payin_method_namestring
Example:au_bank_npp

Payin method name

start_timeinteger
Example:1690694621

EPOCH timestamp

end_timeinteger
Example:1722317021

EPOCH timestamp

limitinteger
Example:10

Max number of transactions per page. Default is 10 transactions per page

pageinteger
Example:1

The page number to return. If unspecified, the first page is returned

Response

OK

request_idstring
request_timestring date-time
status_codeinteger
status_textstring
successboolean

Example response

{
  "data": [
    {
      "additional_data": null,
      "advanced_redirect_url": null,
      "amount": 22,
      "cancelled_at": null,
      "checkout_id": null,
      "created_at": "2022-03-20T15:16:00.684Z",
      "credit_wallet_id": "wallet_031fdbb28534493585e2bdea5a14d846",
      "credit_wallet_transaction_id": null,
      "currency": "AUD",
      "customer_id": null,
      "description": "22 AUD @ Ecommerce Store",
      "expire_at": "2022-03-22T15:16:01.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": false,
      "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": "invoice_123@finmo.net"
      },
      "payin_id": "payin_0f7ee2eccc8b43e589d4cd76d0d84ead",
      "payin_method_category": "bank",
      "payin_method_description": "The New Payments Platform",
      "payin_method_name": "au_bank_npp",
      "payin_method_param": {
        "payid_reference": "invoice_123"
      },
      "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-20T15:16:00.684Z",
      "virtual_account_id": null,
      "webhook_url": null
    }
  ]
}

Changes