Request
Curl
Response
Success
Parameters
id mandatory
: string The unique identifier of the Customer Identifier for which the payment details are to be fetched.
Parameters
from optional
: integer Timestamp, in seconds, from when payments are to be fetched.
to optional
: integer Timestamp, in seconds, till when payments are to be fetched.
count optional
: integer Number of payments to be fetched. The default value is 10 and the maximum value is 100. This can be used for pagination, in combination with skip.
skip optional
: integer Number of records to be skipped while fetching the payments. This can be used for pagination, in combination with count.
Parameters
id
: string Unique identifier of the payment.
entity
: string Indicates the type of entity.
amount
: integer The payment amount in currency subunits. For example, for an amount of 1 enter 100.
currency
: string The currency in which the payment is made.
status
: string The status of the payment. Possible values:
createdauthorizedcapturedrefundedfailed
method
: string The payment method used for making the payment. Possible values:
cardnetbankingwalletemiupi
order_id
: string Order id, if provided. Know more about Orders.
description
: string Description of the payment, if any.
international
: boolean Indicates whether the payment is done via an international card or a domestic one. Possible values:
true: Payment made using international card.false: Payment not made using international card.
refund_status
: string The refund status of the payment. Possible values:
nullpartialfull
amount_refunded
: integer The amount refunded in currency subunits. For example, if amount_refunded = 100, it is equal to 1.
captured
: boolean Indicates if the payment is captured. Possible values:
true: Payment has been captured.false: Payment has not been captured.
email
: string Customer email address used for the payment.
contact
: string Customer contact number used for the payment.
fee
: integer Fee (including GST) charged by Razorpay.
tax
: integer GST charged for the payment.
error_code
: string Error that occurred during payment. For example, BAD_REQUEST_ERROR.
error_description
: string Description of the error that occurred during payment. For example, Payment processing failed because of incorrect OTP.
error_source
: string The point of failure. For example, customer.
error_step
: string The stage where the transaction failure occurred. The stages can vary depending on the payment method used to complete the transaction. For example, payment_authentication.
error_reason
: string The exact error reason. For example, incorrect_otp.
notes
: json object Contains user-defined fields, stored for reference purposes.
created_at
: integer Timestamp, in UNIX format, on which the payment was created.
card_id
: string The unique identifier of the card used by the customer to make the payment.
card
: object Details of the card used to make the payment.
id
: string The unique identifier of the card used by the customer to make the payment.
entity
: string The name of the entity. Here, it is card.
name
: string Name of the cardholder.
last4
: integer The last 4 digits of the card number.
network
: string The card network. Possible values:
American ExpressDiners ClubMaestroMasterCardRuPayUnknownVisa
type
: string The card type. Possible values:
creditdebitprepaidunknown
issuer
: string The card issuer. The 4-character code denotes the issuing bank.
Handy Tips
emi
: boolean Indicates whether the card can be used for EMI payment method. Possible values:
true: Card can be used for EMI payments.false: Card cannot be used for EMI payments.
sub_type
: string The sub-type of the customer’s card. Possible values:
customerbusiness
Handy Tips
upi
: object Details of the UPI payment received. Only applicable if method is upi.
payer_account_type
: string The payment method used for making the payment. Possible values:
bank_accountcredit_cardwallet
vpa
: string The customer’s VPA (Virtual Payment Address) or UPI id used to make the payment. For example, gauravkumar@exampleupi.
flow
: string The type of UPI flow. Possible value in_app.
Handy Tips
flow is present only in the case of Turbo UPI Payments.
bank
: string The 4-character bank code which the customer’s account is associated with. For example, UTIB for Axis Bank.
vpa
: string The customer’s VPA (Virtual Payment Address) or UPI id used to make the payment. For example, gauravkumar@exampleupi.
wallet
: string The name of the wallet used by the customer to make the payment. For example, payzapp.
acquirer_data
: array A dynamic array consisting of a unique reference numbers.
rrn
: string A unique bank reference number provided by the banking partner when a refund is processed. This reference number can be used by the customer to track the status of the refund with the bank.
authentication_reference_number
: string A unique reference number generated for RuPay card payments.
bank_transaction_id
: string A unique reference number provided by the banking partner in case of netbanking payments.
Errors
The API “ provided is invalid.- code: 4xx
- description: Occurs when there is a mismatch between the API credentials passed in the API call and the API credentials generated on the dashboard.
- solution: Make sure that the API keys are active and entered correctly. Also, make sure there are no whitespaces before or after the keys.