Skip to main content

Callback Payload​

This API returns the data of order .

Query Parameters
    order_id any

    The order_id for which the payment is being made

    transaction_id any

    The transaction_id for which payment is being made

Responses

When the egt token api is successful, the response will be as below

Schema
    status string

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

    Current status of the payment event

    message string

    TA message describing the payment event

    nimbbl_order_id string

    Nimbbl order ID

    nimbbl_transaction_id string

    Nimbbl transaction ID

    nimbbl_signature string

    Nimbbl signature

    order_id string

    The order_id for which the payment is being made

    transaction_id string

    The transaction_id for which the payment is being made

    signature string

    Nimbbl signature

    order object

    Details of the order

    invoice_id string

    The invoice_id for which payment is being made

    status string

    Current status of the payment event

    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

    transaction object

    Details of the transaction

    transaction_id string

    Nimbbl transaction ID

    status string

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

    Current status of the payment event

    payment_partner string

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

    psp_transaction_id string

    This is the transaction reference generated by the payment partner

    transaction_amount string

    Amount of the transaction

    transaction_type string

    Type of transaction (payment, refund)

    transaction_currency string

    Currency of the transaction

    additional_charges string

    Additional charges for the transaction

    offer_discount string

    This is the amount that will be discounted as per the offers that have been configured by you

    offer_id string

    This is the unique offer id provided by Nimbbl, it can be used in subsequent API calls

    signature string

    Nimbbl signature

    signature_version string

    This specifies the signature generation logic to be used for signature verification

Loading...