Skip to main content

Transaction Enquiry [v3]​

This API will get the latest status of the order and associated transactions.

note
  • The API supports an input of transaction_id, order_id or invoice_id
  • If you provide an order_id or invoice_id you can get more than one transactions that are associated with the order or invoice
Request Body required
    transaction_id string nullable

    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.

    order_id string nullable

    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

    invoice_id string nullable

    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

Responses

When the transaction enquiry request is processed, the response will be as below

Schema
    transaction object[] required

    The list of transactions associated with the order_id or invoice_id as provided in the request. If the request contained a transaction_id then this list will contain only a single transaction

  • Array [
    • transaction_type string required

    This is the type of the transaction

    nimbbl_transaction_id string required

    The transaction_id of the payment transaction

    payment_status string required

    Possible values: [new, pending, failed, succeeded, reversing, reversed]

    The status of the payment transaction

    message string required

    A message reflecting the status of the transaction

    nimbbl_signature string required

    This is signature generated at Nimbbl using the access_secret provided to you. You should validate the genuineness of the Nimbbl response by generating a signature and comparing it with the one received from Nimbbl

    failure_reason object nullable

    If the payment has failed, you can get the reason for failure from this object

    nimbbl_error_code string required

    This is the error_code generated by Nimbbl

    nimbbl_consumer_message string required

    This is a customer friendly message that can be displayed to your consumer or shared by your customer service agent to the customer

    nimbbl_merchant_message string required

    This explains to your team how to recover from the error

    retry_allowed boolean required

    This field suggests whether a retry should be allowed for the customer using the same payment mode.

    payment_partner string required

    This is the payment partner through which the payment has been processed

    psp_transaction_id string required

    This is the transaction reference generated by the payment partner

    completion_time integer required

    The time in seconds it took for the transaction to be completed

  • ]
    • order object required

    The details of the order that is linked with the order_id or invoice_id or transaction_id passed in the request

    nimbbl_order_id string required

    This is the Nimbbl generated unique order_id for your invoice_id

    invoice_id uuid required

    This is your internal unique reference identifier for this order

    status string required

    Possible values: [new, pending, completed, lapsed]

    This is the status of the order

    custom_attributes object[] nullable

    The array of custom attributes created along with the create order

  • Array [
    • key string required

    The key that you have created as a custom parameter with the create order request

    value string required

    The value that you have ascribed to the key as a custom parameter with the create order request

  • ]
    • currency_conversion object nullable

    This object is sent only if the transaction currency was changed. This object will have all the details related to currency conversion.

    original_currency string

    This is the currency code in ISO-4217 format in which the order was initiated

    converted_currency string

    This is the currency code in ISO-4217 format in which the order will be processed in

    exchange_rate number

    This is the exchange rate used to convert amounts from original currency to converted currency

    conversion_reason string

    Possible values: [ALTERNATE_CURRENCY_CONFIG]

    This is the reason for currency conversion

    original_amount_before_tax number nullable

    This is the amount_before_tax received when the order was initiated

    original_tax number

    This is the tax when the order was initiated, if not received will be set to 0

    original_total_amount number

    This is the total_amount received when the order was initiated

    refund_details object nullable

    This field will only come when the order_status is completed. This object will have all the refund details for the order.

    refundable_currency string

    This is the currency code in ISO-4217 format in which the refund will be initiated

    available_refundable_amount number

    This is the amount which is available for refund

    refunded_amount number

    This is the amount which has been already refunded successfully

    total_refundable_amount number

    This is the maximum refundable amount available for the order

Loading...