JIjiopay
Payment Links

Retrieve a payment link

Retrieve details of a payment link.

get/api/v1/payin/{id}

Request

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

Path parameters

idstring required
Example:payin_678a4c88hpAjf

The ID of the payin

Response

OK

idstring

The unique identifier for the payment link.

customer_idstring

The unique identifier of customer linked to payment_link.

document_idstring

The unique identifier of document linked to payment_link. This document entity should contain the required documents to process incoming payments. Refer to the Document entity for more details.

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

The status of the payment_link.

payment_methodsPaymentMethod[]

Array of payment methods available for the customer on the checkout page.

currencystring

The currency code in ISO 4217 format. Supported currencies: USD, EUR and GBP.

amountnumber

The amount you want to receive, a positive integer representing the smallest currency unit. For example, if the amount is $299.00, then pass 29900 in this field. In the case of three decimal currencies, such as KWD, BHD and OMR, to represent an amount of 295.991, pass the value as 295990. And in the case of zero decimal currencies such as JPY, for amount ¥295, pass the value as 295.

purpose_codestring

Purpose code for why you want to receive this payment

invoice_numberstring

Number/Id of the invoice submitted with payment_link.

invoice_descriptionstring

Description about the invoice submitted with payment_link

reference_numberstring

Optional identifier to be sent for reconciliations

expires_atstring

Date when the payment_link will expire. Expiry can not be less than or equal to current date and can be upto 6 months in future.

last_reminder_sent_atstring

Last time when the customer was reminded to complete the payment by visiting the link

invoice_amountnumber

The amount in cents for which invoice was generated. It can be more than the amount requested in this payment_link

payment_linkstring

Sharable link which should be shared with the customer you want to receive money from. This link gets generated only after the payin has been reviewed and moved to in_progress

notify_customerboolean

Whether to notify the customer via email when the payment link is created. Defaults to true. Set to false to suppress the notification email.

reminder_frequencynumber

The frequency at which you want to remind customers, valid values are 1 (remind everyday), 2 (remind every alternate day), 7 (remind every week), 14 (remind every alternate week).

price_idstring

The unique identifier of 'Price' entity linked to the payment link. This is the referral fee for this payment link. Note: price_id is only applicable for platform businesses.

created_atstring

Timestamp representing when the payment_link was created

updated_atstring

Timestamp representing when the payment_link was last updated

notesNotes nullable

Optional key-value pairs for attaching custom metadata (e.g. invoice references, project codes). Keys must be strings and cannot collide with reserved field names. If your business has custom field rules configured (e.g. enum constraints), values are validated against those rules. Each key appears as a separate column in CSV report exports, with corresponding values populating the rows.

Example response

{
  "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"
    }
  ]
}

Changes

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