Introduction

API Reference Guide

API Changelog

Understand Razorpay APIs

Authentication

Sandbox Setup

Best Practices

Glossary

Payments

Orders

Payments

Downtime

Settlements

Instant Settlements

Refunds

Disputes

Documents

Customers

Payment Links

QR Codes

Invoices

Subscriptions

Route

Smart Collect

Smart Collect Entity

Create a Customer Identifier With Bank Account Receiver

Close a Customer Identifier

Fetch a Customer Identifier Using ID

Fetch all Customer Identifiers

Fetch Payments for a Customer Identifier

Fetch Payments Made By Bank Transfer

Fetch Payments Using UTR Number

Update a Customer Identifier

Smart Collect TPV

Smart Collect With TPV Entity

Create a Customer Identifier With TPV

Add an Allowed Payer With TPV

Fetch a Customer Identifier Using ID With TPV

Fetch All Customer Identifiers With TPV

Fetch Payments for a Customer Identifier With TPV

Fetch Payment Details Using ID and Transfer Method With TPV

Delete an Allowed Payer With TPV

Smart Collect 2.0

Smart Collect 2.0 Entity

Create Customer Identifier With VPA and Bank Account Receivers (Smart Collect 2.0)

Add VPA Receiver to an Existing Customer Identifier (Smart Collect 2.0)

Fetch Payments Made Using UPI (Smart Collect 2.0)

TPAP Pro

Customer Onboarding

Accounts Management

Payments

Mandates

Complaints

UPI Number

UPI Lite

Bills

About Bills

Bills Entity

Create a Bill

Update a Bill

Delete a Bill

Partners

Account

Product Configuration

Stakeholder

Documents

Webhooks

Payout APIs

Get Started

Account Validation

Fetch Balance

Composite Account Validation

Contacts

Fund Accounts

Payouts

Payouts to Cards

Payout Composite

Payouts Approval

Payout Idempotency

Payout Links

Payout Wallet - Amazon

Transactions

Api

Payments

Smart Collect Tpv

Fetch Payments

API Test Keys

Fetch Payments for a Customer Identifier With TPV

GET
/v1/virtual_accounts/:id/payments

Click to copy

Use this endpoint to fetch payments made against a particular Customer Identifier.

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/virtual_accounts/va_CminDKtoToBGmd/payments \

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": "bank_transfer",
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": null,
23
      "email": "gaurav.kumar@example.com",
24
      "contact": "+919000090000",
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
}
Path Parameters
id

*

string

The unique identifier of the Customer Identifier for which the payment details are to be fetched.

Query Parameters
from
integer

Timestamp, in seconds, from when payments are to be fetched.

to
integer

Timestamp, in seconds, till when payments are to be fetched.

count
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
integer

Number of records to be skipped while fetching the payments. This can be used for pagination, in combination with count.

Response Parameters
id
string

The unique identifier of the Customer Identifier.

name
string

The merchant billing label as it appears on the Dashboard.

entity
string

Indicates the type of entity. Here, it is virtual account.

status
string

Indicates whether the Customer Identifier is in active or closed state.

description
string

A brief description about the Customer Identifier.

amount_paid
integer

The amount paid by the customer into the Customer Identifier.

notes
json object

Any custom notes you might want to add to the Customer Identifier can be entered here. Check the

Notes section

to know more.

customer_id
string

Unique identifier of the customer the Customer Identifier is linked with. Check the

Customer API

section to know more.

receivers
json object

Configuration of desired receivers for the Customer Identifier.

Show child parameters (7)

allowed_payers
array

Details of customer bank accounts which will be allowed to make payments to your Customer Identifier. The parent parameter under which the customer bank account details must be passed as child parameters. You can add account details of 10 allowed payers for a Customer Identifier. For more details, refer to the

Third Party Validation

section.

Show child parameters (3)

close_by
integer

UNIX timestamp at which the Customer Identifier is scheduled to be automatically closed. The time must be at least 15 minutes after current time. The date range can be set till 2147483647 in UNIX timestamp format (equivalent to Tuesday, January 19, 2038 8:44:07 AM GMT+05:30). Any request beyond 2147483647 UNIX timestamp will fail.

closed_at
integer

UNIX timestamp at which the Customer Identifier is automatically closed.

created_at
integer

UNIX timestamp at which the Customer Identifier was created.

Errors

The API <key/secret> provided is invalid.

Error Status: 4xx

Occurs when there is a mismatch between the API credentials passed in the API call and the API credentials generated on the dashboard.

Solution

Fetch Payments for a Customer Identifier With TPV

GET
/v1/virtual_accounts/:id/payments

Click to copy

Use this endpoint to fetch payments made against a particular Customer Identifier.

Is this page helpful?

Path Parameters
id

*

string

The unique identifier of the Customer Identifier for which the payment details are to be fetched.

Query Parameters
from
integer

Timestamp, in seconds, from when payments are to be fetched.

to
integer

Timestamp, in seconds, till when payments are to be fetched.

count
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
integer

Number of records to be skipped while fetching the payments. This can be used for pagination, in combination with count.

Response Parameters
id
string

The unique identifier of the Customer Identifier.

name
string

The merchant billing label as it appears on the Dashboard.

entity
string

Indicates the type of entity. Here, it is virtual account.

status
string

Indicates whether the Customer Identifier is in active or closed state.

description
string

A brief description about the Customer Identifier.

amount_paid
integer

The amount paid by the customer into the Customer Identifier.

notes
json object

Any custom notes you might want to add to the Customer Identifier can be entered here. Check the

Notes section

to know more.

customer_id
string

Unique identifier of the customer the Customer Identifier is linked with. Check the

Customer API

section to know more.

receivers
json object

Configuration of desired receivers for the Customer Identifier.

Show child parameters (7)

allowed_payers
array

Details of customer bank accounts which will be allowed to make payments to your Customer Identifier. The parent parameter under which the customer bank account details must be passed as child parameters. You can add account details of 10 allowed payers for a Customer Identifier. For more details, refer to the

Third Party Validation

section.

Show child parameters (3)

close_by
integer

UNIX timestamp at which the Customer Identifier is scheduled to be automatically closed. The time must be at least 15 minutes after current time. The date range can be set till 2147483647 in UNIX timestamp format (equivalent to Tuesday, January 19, 2038 8:44:07 AM GMT+05:30). Any request beyond 2147483647 UNIX timestamp will fail.

closed_at
integer

UNIX timestamp at which the Customer Identifier is automatically closed.

created_at
integer

UNIX timestamp at which the Customer Identifier was created.

Errors

The API <key/secret> provided is invalid.

Error Status: 4xx

Occurs when there is a mismatch between the API credentials passed in the API call and the API credentials generated on the dashboard.

Solution

Curl

change language

change language

1
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2
-X GET \
3
https://api.razorpay.com/v1/virtual_accounts/va_CminDKtoToBGmd/payments \

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": "bank_transfer",
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": null,
23
      "email": "gaurav.kumar@example.com",
24
      "contact": "+919000090000",
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
}