Orders

Create a new order

Create an order for checkout in one of two ways:

Order without quote — specify the amount, currency and payment methods inline (Orders).
Order with quote — pass a quote_id from POST /quotes (with resource: payin) to bind the order to a quote. When supplied, the quote is the single source of truth for amount, currency, payment method and expiry; the locked fields (amount, currency, price_id, payment_methods) must not be sent (CreateOrderWithQuoteRequest). When a quote_id is supplied, the order's expiry is set to the quote's expiry.

The request variant is selected by the presence of quote_id.

post/api/v1/orders

Request

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

Request body

Example request

{
  "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",
  "invoice_amount": 1000,
  "reference_number": "R0001",
  "price_id": "price_E602dMzgjpDC",
  "notes": {
    "invoice_ref": "INV-2026-001",
    "project": "Alpha"
  },
  "bank_account_details": {
    "account_number": "1234567890",
    "bic_primary": "HDFCINBBDEL",
    "bic_secondary": "HDFC0001097",
    "bank_customer_id": "7189204715"
  },
  "request_id": "unique_order_request_id_123"
}

Response

Created

idstring

The unique identifier for the order.

customer_idstring

The unique identifier of customer linked to order.

document_idstring

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

The status of the Order.

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 order.

invoice_descriptionstring

Description about the invoice submitted with order

invoice_amountnumber

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

reference_numberstring

Optional identifier to be sent for reconciliations

price_idstring

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

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.

payment_methodsPaymentMethod[]

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

created_atstring

Timestamp representing when the order was created

updated_atstring

Timestamp representing when the order was last updated

request_idstring

Optional idempotency key.

Example response

{
  "id": "order_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",
  "invoice_amount": 1000,
  "reference_number": "R0001",
  "price_id": "price_E602dMzgjpDC",
  "notes": {
    "invoice_ref": "INV-2026-001",
    "project": "Alpha"
  },
  "bank_account_details": {
    "account_number": "1234567890",
    "bic_primary": "HDFCINBBDEL",
    "bic_secondary": "HDFC0001097",
    "bank_customer_id": "7189204715"
  },
  "created_at": "2021-06-01T12:00:00Z",
  "updated_at": "2021-06-01T12:00:00Z",
  "request_id": "unique_order_request_id_123",
  "rfi_documents": [
    {
      "rfi_doc_id": "rfidoc_123",
      "name": "Passport"
    }
  ]
}

Changes

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