API Reference
Log In
API Reference

This endpoint returns the details of a payment related to a particular payment request.

To check whether the payment was successful or not use the "status" key inside the "payment" dictionary. If the status is "Credit" then the payment was successful otherwise it failed.

Required Headers:

  • X-Api-Key
  • X-Auth-Token

Response Fields

instrument_type CARD
EMI
NETBANKING
UPI
* WALLET
Indicates the instrument type used for the payment.
failure null
Object:
reason
message
Gives the failure reason of why the payment failed. This will have non-null values for failed payments only.

reason => Type of failure.
message => Failure message returned by upstream provider.
billing_instrument null
Unknown card
Domestic Regular Credit Card (Visa/Mastercard)
Domestic Premium Credit/Charge Card (Amex/Diners)
Domestic Regular Debit Card (Visa/Mastercard)
International Regular Credit Card (Visa/Mastercard)
International Premium Credit/Charge Card (Amex/Diners)
International Regular Debit Card
Domestic Netbanking Category A (HDFC/ICICI)
Domestic Netbanking Category B (Other banks)
Wallet
UPI
Unknown netbanking choice
EMI Payment
* Bank Transfer
Gives the subcategory of the 'instrument_type' that was used to make the Payment.
payout null
Object:
id
paid_out_at
Gives you the Payout details once the Payout has been processed.

The response will be 'null' for the cases where the Payout has not been processed yet.
Language
Click Try It! to start a request and see the response here!