Transaction Enquiry [v3]
This API will get the latest status of the order and associated transactions.
- The API supports an input of
transaction_id
,order_id
orinvoice_id
- If you provide an
order_id
orinvoice_id
you can get more than one transactions that are associated with the order or invoice
Request Body required
This is the Nimbbl provided transaction_id. You would have received this when you initiated a payment and subsequently in other API responses as well. You need to either provide the transaction_id
or the invoice_id
or the order_id
.
This is the Nimbbl provided order_id. You would have received this when you created an order. You need to either provide the transaction_id
or the invoice_id
or the order_id
This is your unique reference used for creating an order. You need to either provide the transaction_id
or the invoice_id
or the order_id
- 200
- 4XX
- 5XX
When the transaction enquiry request is processed, the response will be as below
Schema
transaction object[] required
order object required
{
"transaction": [
{
"transaction_type": true,
"completion_time": 35,
"nimbbl_transaction_id": "string",
"payment_status": "failed",
"message": true,
"nimbbl_signature": null,
"failure_reason": {
"nimbbl_error_code": true,
"nimbbl_consumer_message": true,
"nimbbl_merchant_message": true,
"retry_allowed": true
},
"payment_partner": "Razorpay",
"psp_transaction_id": true,
"transaction_amount": true,
"transaction_currency": "INR",
"additional_charges": true,
"offer_discount": true,
"offer_id": "offer_123456",
"signature_version": "v2",
"processing_payment_partner": true,
"payment_acquirer": "AXIS",
"payment_mode": "Netbanking",
"payment_arn": "payment_arn_12345",
"emi": {
"issuer_code": "BOI",
"subvention_type": "standard",
"card_network_code": "visa",
"installment_amount": 300,
"interest_discount": 0,
"cashback_amount": 0,
"tenure": 3,
"frequency": "daily",
"processing_fee_data": {
"fee": 0.1,
"gst_exclusive": true
},
"interest_amount": 50,
"interest_rate": 12,
"subvented_interest_rate": 12
},
"sub_payment_mode": {
"bank_name": "Axis Bank"
},
"refund_status": "failed",
"refund_request_id": "ref_req_12345",
"refund_arn": "ref_arn_12345"
}
],
"order": {
"nimbbl_order_id": "o_9yo5wxlLlbJGK6dp",
"invoice_id": "inv_asjjeibdhakk49hnek3",
"status": "completed",
"custom_attributes": [
{
"key": "name",
"value": "Diana"
}
],
"currency_conversion": {
"original_currency": "USD",
"converted_currency": "INR",
"exchange_rate": 83.72,
"conversion_reason": "ALTERNATE_CURRENCY_CONFIG",
"original_amount_before_tax": 11.94,
"original_tax": 2.15,
"original_total_amount": 14.09
},
"refund_details": {
"refundable_currency": "INR",
"available_refundable_amount": 1180,
"refunded_amount": 0,
"total_refundable_amount": 1180
}
}
}
When the transaction enquiry request is not processed, the response will be as below
Schema
error object
{
"error": {
"nimbbl_error_code": "INVALID_REQUEST_PARAMETER",
"nimbbl_consumer_message": "Sorry, your payment cannot be processed due to a technical error. Please try again after some time.",
"nimbbl_merchant_message": "There is an input validation error, please check the payload of your request."
}
}
When there is a problem on the server, the response will be as below
Schema
error object
{
"error": {
"nimbbl_error_code": "INVALID_REQUEST_PARAMETER",
"nimbbl_consumer_message": "Sorry, your payment cannot be processed due to a technical error. Please try again after some time.",
"nimbbl_merchant_message": "There is an input validation error, please check the payload of your request."
}
}
POST /api/v3/transaction-enquiry
Authorization
name: bearerAuthtype: httpscheme: bearerbearerFormat: JWTdescription: All APIs need to have this as part of the header to get access to the resources exposed by the API
Request
Request
curl -L -X POST 'https://api.nimbbl.tech/api/v3/transaction-enquiry' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"transaction_id": "o_Rz4Zx2WeyooEpyxa-221117104614",
"order_id": "o_Rz4Zx2WeyooEpyxa",
"invoice_id": "inv_asjjeibdhakk49hnek3"
}'
curl -L -X POST 'https://api.nimbbl.tech/api/v3/transaction-enquiry' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"transaction_id": "o_Rz4Zx2WeyooEpyxa-221117104614",
"order_id": "o_Rz4Zx2WeyooEpyxa",
"invoice_id": "inv_asjjeibdhakk49hnek3"
}'
curl -L -X POST 'https://api.nimbbl.tech/api/v3/transaction-enquiry' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"transaction_id": "o_Rz4Zx2WeyooEpyxa-221117104614",
"order_id": "o_Rz4Zx2WeyooEpyxa",
"invoice_id": "inv_asjjeibdhakk49hnek3"
}'
curl -L -X POST 'https://api.nimbbl.tech/api/v3/transaction-enquiry' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"transaction_id": "o_Rz4Zx2WeyooEpyxa-221117104614",
"order_id": "o_Rz4Zx2WeyooEpyxa",
"invoice_id": "inv_asjjeibdhakk49hnek3"
}'
curl -L -X POST 'https://api.nimbbl.tech/api/v3/transaction-enquiry' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"transaction_id": "o_Rz4Zx2WeyooEpyxa-221117104614",
"order_id": "o_Rz4Zx2WeyooEpyxa",
"invoice_id": "inv_asjjeibdhakk49hnek3"
}'
curl -L -X POST 'https://api.nimbbl.tech/api/v3/transaction-enquiry' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"transaction_id": "o_Rz4Zx2WeyooEpyxa-221117104614",
"order_id": "o_Rz4Zx2WeyooEpyxa",
"invoice_id": "inv_asjjeibdhakk49hnek3"
}'
curl -L -X POST 'https://api.nimbbl.tech/api/v3/transaction-enquiry' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"transaction_id": "o_Rz4Zx2WeyooEpyxa-221117104614",
"order_id": "o_Rz4Zx2WeyooEpyxa",
"invoice_id": "inv_asjjeibdhakk49hnek3"
}'
curl -L -X POST 'https://api.nimbbl.tech/api/v3/transaction-enquiry' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"transaction_id": "o_Rz4Zx2WeyooEpyxa-221117104614",
"order_id": "o_Rz4Zx2WeyooEpyxa",
"invoice_id": "inv_asjjeibdhakk49hnek3"
}'
curl -L -X POST 'https://api.nimbbl.tech/api/v3/transaction-enquiry' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"transaction_id": "o_Rz4Zx2WeyooEpyxa-221117104614",
"order_id": "o_Rz4Zx2WeyooEpyxa",
"invoice_id": "inv_asjjeibdhakk49hnek3"
}'