Payments

List all payments

get/api/v1/payment

Request

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

Query parameters

customer_idstring

Example:cust_E602sMzgjpDC

The unique identifier for the customer.

status'success' | 'failed' | 'action_required' | 'in_progress'

Status of payin to filter

payin_idstring

Example:payin_E602dMzgjpDC

The unique identifier for the payin.

payment_type'payment_link' | 'orders' | 'add_funds'

The type of the payin.

Filters payments by their payin type. Use add_funds to list only Add Balance top-ups crediting your Funded Balance.

subscription_idstring

Example:sub_68877570b5zeE

The unique identifier for the subscription.

currencystring

Example:USD

The currency in which the payment is made. The currency code is in ISO 4217 format. For example, USD.

request_idstring

Example:unique_request_id_123

Filter payments by the merchant-provided idempotency key.

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

Example response

{
  "data": [
    {
      "id": "payt_E602dMzgjpDC",
      "payin_id": "payin_E602dMzgjpDC",
      "subscription_id": "sub_68877570b5zeE",
      "payment_currency": "AED",
      "payment_amount": 374580,
      "converted_currency": "USD",
      "converted_amount": 102000,
      "requested_currency": "USD",
      "requested_amount": 100000,
      "purpose_code": "S0001",
      "sender_name": "John Doe",
      "notes": {
        "policy_number": "POL-001"
      },
      "error_code": "PAYMENT_DECLINED",
      "error_description": "The payment attempt was declined. This could be due to issuer rejection, risk assessment, or restrictions on the card or account. The customer should contact their bank or try a different payment method.",
      "customer_error_description": "Your payment could not be completed. Please try a different payment method or contact your bank.",
      "paid_at": "2024-12-06T11:38:37.130Z",
      "created_at": "2024-12-06T11:38:37.130Z",
      "updated_at": "2024-12-06T11:38:37.130Z",
      "customer_id": "cust_E602sMzgjpDC",
      "merchant_id": "merch_68c777fcOOMpl",
      "product_name": "ShieldGuard Insurance",
      "product_description": "Simple, monthly insurance plan that covers your basic belongings and key digital assets",
      "country": "IND",
      "fee_breakdown": {
        "fx_fee": [
          {
            "amount": 250,
            "currency": "USD",
            "taxes": [
              {
                "amount": 1800,
                "currency": "USD",
                "name": "GST",
                "bps": 1800
              }
            ]
          }
        ],
        "txn_fee": [
          {
            "amount": 250,
            "currency": "USD",
            "taxes": [
              {
                "amount": 1800,
                "currency": "USD",
                "name": "GST",
                "bps": 1800
              }
            ]
          }
        ],
        "referral_fee": [
          {
            "amount": 250,
            "currency": "USD",
            "taxes": [
              {
                "amount": 1800,
                "currency": "USD",
                "name": "GST",
                "bps": 1800
              }
            ]
          }
        ]
      },
      "documents": [
        {
          "id": "doc_nYUqLpuYQ0M8",
          "type": "invoice",
          "rfi_doc_id": "rfidoc_nYUqLpuYQ0M8"
        }
      ],
      "payment_method": {
        "id": "swift_6883291fT7Rfw",
        "details": {
          "sender_name": "Vaibhav LRS",
          "sender_country": "IND",
          "sender_account_number": "5454545454",
          "remittance_information": "PaymentForLrs"
        }
      },
      "auto_debit": true,
      "fees": {
        "txn_fee": {
          "amount": 1000,
          "currency": "USD"
        }
      }
    }
  ],
  "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.