API Test Keys

Fetch Payments Made Using Bank Transfer via UTR

GET
/v1/payments?skip=0&count=25&va_transaction_id=:id&virtual_account=1

Click to copy

Use this endpoint to retrieve details of payments made using the bank transfer method via UTR.

Is this page helpful?

Curl

change language

change language

1
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2
-X GET \
3
https://api.razorpay.com/v1/payments?skip=0&count=25&va_transaction_id=209817848101&virtual_account=1
4
-H "Content-Type: application/json" \

Success

1
{
2
"entity": "collection",
3
"count": 1,
4
"items": [
5
{
6
"id": "pay_JGmL38CqCHTyZZ",
7
"entity": "payment",
8
"amount": 1000,
9
"currency": "INR",
10
"status": "captured",
11
"order_id": null,
12
"invoice_id": null,
13
"international": false,
14
"method": "upi",
15
"amount_refunded": 0,
16
"refund_status": null,
17
"captured": true,
18
"description": null,
19
"card_id": null,
20
"bank": null,
21
"wallet": null,
22
"vpa": "gaurav.kumar@exampleupi ",
23
"email": "saurav.kumar@example.com",
24
"contact": "+919900990099",
25
"customer_id": "cust_HWj3MjySAHSjtq",
26
"notes": [],
27
"fee": 12,
28
"tax": 2,
29
"error_code": null,
30
"error_description": null,
31
"error_source": null,
32
"error_step": null,
33
"error_reason": null,
34
"acquirer_data": {
35
"rrn": "209817848101"
36
},
37
"created_at": 1649402719
38
}
39
]
40
}
Query Parameters
count
integer

Number of payments to be fetched. Default value is 10. Maximum value is 100. This can be used for pagination, in combination with the skip parameter.

skip
integer

Number of records to be skipped while fetching the payments.

va_transaction_id
integer

The unique id of the transaction done via a Customer Identifier.

virtual_account
integer

The product used to fetch is Customer Identifiers.
Possible values: 1

Response 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.00 enter 100.

currency
string

The currency in which the payment is made.

status
string

The status of the payment. Possible values:

  • created
  • authorized
  • captured
  • refunded
  • failed

method
string

The payment method used for making the payment. Possible values:

  • card
  • netbanking
  • wallet
  • emi
  • upi

order_id
string

Order id, if provided. Know more about

.

description
string

Description of the payment, if any.

international
boolean

Indicates whether the payment is done via an international card or a domestic one.

refund_status
string

The refund status of the payment. Possible values:

  • null
  • partial
  • full

amount_refunded
integer

The amount refunded in currency subunits. For example, if amount_refunded = 100, it is equal to ₹1.00.

captured
boolean

Indicates if the payment is 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.

Show child parameters (9)

upi
object

Details of the UPI payment received. Only applicable if method is upi.

Show child parameters (3)

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.

Show child parameters (3)

Fetch Payments Made Using Bank Transfer via UTR

GET
/v1/payments?skip=0&count=25&va_transaction_id=:id&virtual_account=1

Click to copy

Use this endpoint to retrieve details of payments made using the bank transfer method via UTR.

Is this page helpful?

Query Parameters
count
integer

Number of payments to be fetched. Default value is 10. Maximum value is 100. This can be used for pagination, in combination with the skip parameter.

skip
integer

Number of records to be skipped while fetching the payments.

va_transaction_id
integer

The unique id of the transaction done via a Customer Identifier.

virtual_account
integer

The product used to fetch is Customer Identifiers.
Possible values: 1

Response 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.00 enter 100.

currency
string

The currency in which the payment is made.

status
string

The status of the payment. Possible values:

  • created
  • authorized
  • captured
  • refunded
  • failed

method
string

The payment method used for making the payment. Possible values:

  • card
  • netbanking
  • wallet
  • emi
  • upi

order_id
string

Order id, if provided. Know more about

.

description
string

Description of the payment, if any.

international
boolean

Indicates whether the payment is done via an international card or a domestic one.

refund_status
string

The refund status of the payment. Possible values:

  • null
  • partial
  • full

amount_refunded
integer

The amount refunded in currency subunits. For example, if amount_refunded = 100, it is equal to ₹1.00.

captured
boolean

Indicates if the payment is 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.

Show child parameters (9)

upi
object

Details of the UPI payment received. Only applicable if method is upi.

Show child parameters (3)

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.

Show child parameters (3)

Curl

change language

change language

1
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2
-X GET \
3
https://api.razorpay.com/v1/payments?skip=0&count=25&va_transaction_id=209817848101&virtual_account=1
4
-H "Content-Type: application/json" \

Success

1
{
2
"entity": "collection",
3
"count": 1,
4
"items": [
5
{
6
"id": "pay_JGmL38CqCHTyZZ",
7
"entity": "payment",
8
"amount": 1000,
9
"currency": "INR",
10
"status": "captured",
11
"order_id": null,
12
"invoice_id": null,
13
"international": false,
14
"method": "upi",
15
"amount_refunded": 0,
16
"refund_status": null,
17
"captured": true,
18
"description": null,
19
"card_id": null,
20
"bank": null,
21
"wallet": null,
22
"vpa": "gaurav.kumar@exampleupi ",
23
"email": "saurav.kumar@example.com",
24
"contact": "+919900990099",
25
"customer_id": "cust_HWj3MjySAHSjtq",
26
"notes": [],
27
"fee": 12,
28
"tax": 2,
29
"error_code": null,
30
"error_description": null,
31
"error_source": null,
32
"error_step": null,
33
"error_reason": null,
34
"acquirer_data": {
35
"rrn": "209817848101"
36
},
37
"created_at": 1649402719
38
}
39
]
40
}