JIjiopay
Payment Links

List all payment links

Returns a list of your payment links. The payment links are returned sorted by creation date, with the most recent payment link appearing first.

get/api/v1/payin

Request

  • Base URL
    https://api.crossborder.jiopay.co.in
  • URL
    https://api.crossborder.jiopay.co.in/api/v1/payin
  • Auth
    HTTP bearer

Query parameters

customer_idstring
Example:cust_E602dMzgjpDC

Payment links of customer to filter

status'active' | 'paid' | 'failed' | 'action_required' | 'cancelled' | 'partially_paid' | 'under_review' | 'expired'

The status of the payment_link.

Status of payment link to filter

beforestring
Example:2025-02-18T12:03:44Z

ISO-8601 timestamp in UTC to filter resources created before this time. Use this to avoid the page drift issue. See Pagination parameters for more details.

afterstring
Example:2025-01-18T12:03:44Z

ISO-8601 timestamp in UTC to filter resources created after this time. Use this to avoid the page drift issue. See Pagination parameters for more details.

per_pageinteger
Example:20

Number of resources per page. Should be between 1 and 100.

pageinteger
Example:1

Page number for pagination. Starts from 1. Get the next page number from the next field in the response.

Response

OK

Example response

{
  "data": [
    {
      "id": "payin_678a4c88hpAjf",
      "customer_id": "cust_E602dMzgjpDC",
      "document_id": "doc_nYUqLpuYQ0M8",
      "currency": "USD",
      "amount": 1000,
      "purpose_code": "P1401",
      "invoice_number": "RG12FF590",
      "invoice_description": "Payment requested for services provided",
      "reference_number": "R0001",
      "expires_at": "2025-02-15T00:00:00.000Z",
      "last_reminder_sent_at": "2024-09-13T06:32:34.340Z",
      "invoice_amount": 1000,
      "payment_link": "https://api.crossborder.jiopay.co.in/v1/payin/pl/8f31597d-e085-497a-b80f-ae97ea9422a0",
      "notify_customer": true,
      "reminder_frequency": 7,
      "price_id": "price_E602dMzgjpDC",
      "created_at": "2021-06-01T12:00:00Z",
      "updated_at": "2021-06-01T12:00:00Z",
      "notes": {
        "invoice_ref": "INV-2026-001",
        "project": "Alpha"
      },
      "bank_account_details": {
        "account_number": "1234567890",
        "bic_primary": "HDFCINBBDEL",
        "bic_secondary": "HDFC0001097",
        "bank_customer_id": "7189204715"
      },
      "rfi_documents": [
        {
          "rfi_doc_id": "rfidoc_123",
          "name": "Passport"
        }
      ]
    }
  ],
  "page_meta": {
    "current": 2,
    "previous": 1,
    "next": 3,
    "per_page": 20,
    "pages": 10,
    "count": 200
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.