Payments

Retrieve a payment

get/api/v1/payment/{id}

Request

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

Path parameters

idstring required

Example:payt_E602dMzgjpDC

The unique identifier for the payment.

Response

idstring

The unique identifier for the payment.

payin_idstring nullable

The unique identifier for the payin. This is set only for payments associated to a payin.

payin_type'payment_link' | 'orders' | 'add_funds'

The type of the payin.

subscription_idstring nullable

The unique identifier for the subscription. This is set only for subscription-related payments.

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

The status of the payment.

payment_currencystring

The currency in which the customer pays. The currency code is in ISO 4217 format. For example, AED.

payment_amountnumber

The total amount the customer pays in cents (includes customer-borne fees if applicable). For example, 374580 cents is 3,745.80 AED. The currency is determined by the payment_currency field.

converted_currencystring

The settlement currency after conversion. The currency code is in ISO 4217 format. For example, USD.

converted_amountnumber

The final amount after currency conversion in cents (includes all fees). For example, 102000 cents is $1,020.00. The currency is determined by the converted_currency field.

requested_currencystring

The currency that was originally requested by the merchant. The currency code is in ISO 4217 format. For example, USD.

requested_amountnumber

The amount originally requested by the merchant in cents, excluding customer-borne fees. For example, 100000 cents is $1,000.00. The currency is determined by the requested_currency field.

purpose_codestring

The purpose code of the payment. This should match the purpose code of the payin.

sender_namestring

The name of the sender.

notesobject

Custom field values for this payment.

error_codestring

The error code for the respective error.

error_descriptionstring

The merchant-facing error description corresponding to the error code. Operational copy for the merchant. See customer_error_description for the copy meant for the end-customer.

customer_error_descriptionstring nullable

Customer-facing error copy, written for the merchant to relay to their end-customer. Derives from the same error_code as error_description but targets a different audience. null when there is no error_code, or when the error code has no customer-facing variant (some codes are merchant-only, e.g. ACCOUNT_LOCKED, LOGGED_IN_ELSEWHERE, FUNCTIONALITY_RESTRICTED).

paid_atstring nullable

The timestamp at which the payment was completed. null if the payment has not been paid.

fee_bearer'customer' | 'merchant' | 'split'

The party bearing the fees for the payment.

fee_collection_mode'immediate' | 'deferred' nullable

When merchant-borne fees are collected. immediate deducts fees up front; deferred invoices them later. null when not applicable.

created_atstring

The creation timestamp of the payment.

updated_atstring

The last update timestamp of the payment.

customer_idstring

The unique identifier for the customer.

merchant_idstring

The unique identifier for the merchant (business) that owns the payment.

product_namestring nullable

The name of the product associated with the payment.

product_descriptionstring nullable

The description of the product associated with the payment.

countrystring

The country of the sender. Country should be sent as an ISO 3166-1 alpha-3 code.

settlement_idstring

A unique identifier generated for the settlement batch in which this payment is included. This ID can be used to track and reconcile payments against corresponding settlements.

funds_availableboolean

Indicates whether the funds for this payment are currently available. true: funds are available and can be included in a payout or settlement. false: funds are still in transit with the payment partner and are not yet available for use.

auto_debitboolean nullable

Indicates whether the payment was made via auto-debit. Present only for subscription payments; true for an auto-debit payment, false for a manual subscription payment.

Example response

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

Changes

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