get https://api.juspay.in/orders/
split_settlement_response block in the Order Status response would help the merchant to confirm the below points:
-
If split settlement was successfully applied (split_applied: TRUE)
-
Amount settled in the respective sub-account IDs (split_details)
The response for this API is an Order Object, which includes the
split_settlement_response block. Other objects contained in the
Order Object are listed on top: (click to open tables)
split_settlement_response block. Other objects contained in theOrder Object are listed on top: (click to open tables)
| Parameter | Type | Description |
|---|---|---|
| split_settlement_response: {param1, param2, ....} | JSON object | Provides merchant with details (amounts, sub account IDs) if the split settlement was successfully applied. |
Split Settlement Response Object Parameters:
| Parameter | Type | Description |
|---|---|---|
| split_applied | Boolean | Set to 'true' if split settlement was successfully applied |
| split_details: [{...},{...}...] wwwwwwwwwwwwww | Array of Objects | Amount settled in the respective sub-account IDs |
Parameters for each
split_details object in array: | Field | Type | Description |
|---|---|---|
| sub_vendor_id | String | Sub Account ID (maintained at JusPay’s end). |
| amount | Double | Amount to be settled in the sub account |
| payment_links:wwwwwwww {web, mobile, iframe} | Object String | Contains 3 strings that link to a Desktop optimized, Mobile optimized as well as iFrame checkout screen for the given order |
Payment Links Object Parameters:
| Field | Type | Description |
|---|---|---|
| web | String | Link to checkout page that is optimized for Desktop for the given order. |
| mobile | String | Link to Mobile optimized checkout page for the given order. |
| iframe | String | Link to iFrame checkout screen. This is typically embedded inside of your own page. |
Payment Links
These links can directly be emailed or messaged to your customers. They will be redirected using a link to enter payment information. If you wish to use your own branding, then you can embed the iframe link into your page. Note that, these links are not valid perpetually. As soon as your order expires (this can be changed via our dashboard), the link will cease to work.
These links can directly be emailed or messaged to your customers. They will be redirected using a link to enter payment information. If you wish to use your own branding, then you can embed the iframe link into your page. Note that, these links are not valid perpetually. As soon as your order expires (this can be changed via our dashboard), the link will cease to work.
| payment_gateway_response: {param1, param2, ....} | Object String | Object containing payment gateway response details |
Payment Gateway Response Object Parameters:
| Field | Type | Description | Example |
|---|---|---|---|
| txn_id | String | Transaction ID | "11327833" |
| rrn | String | Authorization Retrieval Reference Number | "502913366745" |
| resp_message | String | Result of API action | "Payment Successful" |
| resp_code | String | Numeric code of response message | "0" |
| epg_txn_id | String | Electronic Payment Gateway transaction ID | "1532690566017" |
| created | String | Date time (ISO representation) when order was created | "2020-04-28T06:31:37Z" |
| auth_id_code | String | Authorization ID Code | "475926" |
| txn_detail:wwwwwwwwwwnn {param1, param2, ....} | Object String | Object containing transaction detailswwww |
Transaction Detail Object Parameters:
| Field | Type | Description | Example |
|---|---|---|---|
| txn_uuid | String | Transaction UUID (available in Order Status API response) | "eulneT9JkaAPa1uv" |
| txn_id | String | Transaction ID | "11327833" |
| txn_amount | String | Amount of transaction | 1 |
| tax_amount | String | Amount of tax applied | null |
| surcharge_amount | String | Extra fee charged by merchant on payment | null |
| status | String | Status of the order (see Status Mapping table) | "CHARGED" |
| redirect | boolean | If true, the user is redirected to the return_url configured for the order. | false |
| order_id | String | Unique Identifier for the order. | "145678234" |
| net_amount | String | Net amount of order | 1 |
| gateway_id | String | Unique numeric identifier for your preferred gateway. (Refer to "Gateway Mapping" table.) | 19 |
| gateway | String | Name or your preferred gateway | "PAYTM_V2" |
| express_checkout | boolean | True if using Express Checkout | false |
| error_message | String | Bank error message | "" |
| error_code | String | Numeric code of bank error message | "" |
| currency | String | ISO string of the currency. Use INR for Indian Rupee. Among other accepted values are EUR, USD, GBP. | "INR" |
| created | String | Date time (ISO representation) when order was created | "2020-04-28T06:31:37Z" |
| card:wwwwwwwwwwwwwnt {param1, param2, ....} | Object String | Object containing credit/debit card details |
Card Object Parameters:
| Field | Type | Description |
|---|---|---|
| using_saved_card | boolean | True if using a saved card |
| saved_to_locker | boolean | True if card has been saved to locker |
| last_four_digits | String | Last four digits of card number |
| name_on_card | String | Card holder name. Should contain alphabetical characters only. |
| expiry_year | String | Expiry year of the card (Format: "yyyy") |
| expiry_month | String | Expiry month of the card (Format: "mm") |
| card_type | String | "CREDIT" or "DEBIT" |
| card_reference | String | Unique identifier for the card |
| card_issuer | String | Code for bank that issued the card (Example: "HDFC Bank") |
| card_isin | String | International Securities Identification Number for card (Example: "545721") |
| card_brand | String | Brand of card ("MASTERCARD", "VISA", etc.) |
| Refunds: [{...},{...},..] wwwwwwwwwwwwwwwwwi | Array wwwwt | An array of Refund Objects with details of each refund (returned only if the refunded parameter is set to "true". |
Refund Object Parameters:
| Field | Type | Description |
|---|---|---|
| id | String | ID generated for the refund |
| unique_request_id | Srtring | Unique ID generated for the request |
| ref | String | Reference number provided by the bank for the refund |
| amount | Double | Amount refunded (or to be refunded) |
| created | String | Date time (ISO representation) when refund was created |
| status | String | Status of the refund. Can be one of PENDING, SUCCESS, FAILURE, MANUAL_REVIEW (see table below for meaning). |
| error_message | String | Message if error occured |
| sent_to_gateway | Boolean | Set to 'true' if request was sent to gateway |
| Status | Meaning |
|---|---|
| SUCCESS | This means that the refund has been successfully executed. |
| PENDING | This would mean that the refund has been queued with JusPay or with the downstream system. |
| FAILURE | We were unable to process the refund successfully. You have to try again with new unique_request_id. |
| MANUAL_REVIEW | This would mean that the refund request was sent an ambigious response from the payment gateway and the merchant has to manually reconcile it with the payment gateway to get the proper response. Also, any refunds which are in pending for more than 10 days are set for manual review. |
| merchant_id | String | Unique identifier for the merchant. |
| order_id | String | Unique Identifier for the order. It is suggested to keep the order id length at a maximum of 21 characters irrespective of payment methods and gateways. |
| id | String | Unique ID generated by Juspay for the given order. |
| customer_id | String | String that uniquely identifies the customer. Generated by Juspay when you created customer object. |
| customer_email | String | Email address of the customer. Must be present if backend gateway requires it. |
| customer_phone | String | Mobile number or fixed line number of the customer. Must be present if backend gateway requires it. |
| product_id | String | An identifier for the product on the Lender side for which the payment is being done. This field is just echoed back in the response so that Lender can differentiate on their side. Fits well for impulse purchase usecases. |
| status | String | Status of the order. If you receive “NEW”, then the order has been successfully created (see Status Mapping table below). |
| status_id | Integer | Status ID is a numeric id corresponding to the status value (see Status Mapping table below). |
| amount | double | This is the amount that a customer will be charged in this transaction. Will accept double values with up to two decimal places. For example, 100.15 is valid input but 100.1532 is not valid. |
| currency | String | ISO string of the currency. Use INR for Indian Rupee. Among other accepted values are EUR, USD, GBP. |
| refunded | Boolean | True if the order has been completely refunded. Will be false for partial refunds or if the order doesn’t have any refunds. |
| date_created | String | Date-time of mandate or order creation |
| return_url | String | A fully qualified URL such as http://shop.merchant.com/ to which the customer will be redirected after payment completion. This URL shouldn’t contain any query parameters. This URL takes higher precedence over the common return URL configured in your account. settings. |
| udf1 | String | udf1 to udf10 - User defined field which will be echoed back in the response from Juspay with a Max character limit of 255. |
| udf2 | String | |
| udf3 | String | |
| udf4 | String | |
| udf5 | String | |
| udf6 | String | |
| udf7 | String | |
| udf8 | String | |
| udf9 | String | |
| udf10 | String | |
| txn_id | String | Transaction ID |
| txn_uuid | String | Transaction UUID |
| gateway_id | Integer | Unique numeric identifier for your preferred gateway. (Refer to "Gateway Mapping" table.) |
| gateway_reference_id | String | Alphabetic reference to the payment gateway used |
| bank_error_code | String | Bank Error Code |
| bank_error_message | String | Bank Error Message |
| payment_method_type | String | Must be either CARD, NB, WALLET, or UPI. Entered when creating the order or mandate |
| payment_method | String | Entered when creating the order or mandate. Found in the given tables for the corresponding API and transaction type. |
| auth_type | String | Type of authentication used |
Status Mapping - Order status codes and meaning (click to open table)
| Order Status | ID | Meaning |
|---|---|---|
| CREATED | 1 | Returned when order is successfully created. |
| NEW | 10 | Newly created order. |
| PENDING_VBV | 23 | Authentication is in progress. The customer has to approve the mandate through the PSP App of their choice. |
| CHARGED | 21 | Successful transaction. The subscription cost of the period has been charged. |
| AUTHENTICATION_FAILED | 26 | User did not complete authentication. |
| AUTHORIZATION_FAILED | 27 | User completed authentication, but the bank refused the transaction. |
| JUSPAY_DECLINED | 22 | User input is not accepted by the underlying PG. |
| AUTHORIZING | 28 | Transaction status is pending from bank. |
⭣
The request consists of order_id and two Headers: Content-Type and Authorization, as listed below.