API Test Keys

Fetch Payments Made Using UPI (Smart Collect 2.0)

GET

/v1/payments/:id/upi_transfer

Click to copy

Use this endpoint to retrieve details of payments made using the UPI payment method.

Watch Out!

Smart Collect APIs are not available in Malaysia.

Is this page helpful?

Curl

change language

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

Success

1{
2  "id": "ut_E5YEUKb9yA0YvX",
3  "entity": "upi_transfer",
4  "amount": 100,
5  "payer_vpa": "gauravkumar@exampleupi",
6  "payer_bank": "HDFC BANK LTD",
7  "payer_account": "50100000000001",
8  "payer_ifsc": "HDFC0000004",
9  "payment_id": "pay_E5YETrWuVgP3fI",
10  "npci_reference_id": "001718859181",
11  "virtual_account_id": "va_E5V3Rb3sQaMS5v",
12  "virtual_account": {
13    "id": "va_E5V3Rb3sQaMS5v",
14    "name": "Acme Corp",
15    "entity": "virtual_account",
16    "status": "active",
17    "description": "First Customer Identifier",
18    "amount_expected": null,
19    "notes": [],
20    "amount_paid": 200,
21    "customer_id": "cust_9xnHzNGIEY4TAV",
22    "receivers": [
23      {
24        "id": "vpa_E5V3RsO1g4QK7t",
25        "entity": "vpa",
26        "username": "rpy.payto00000gaurikumari",
27        "handle": "icici",
28        "address": "rpy.payto00000gaurikumari@icici"
29      }
30    ],
31    "close_by": null,
32    "closed_at": null,
33    "created_at": 1579254678
34  }
35}

Path Parameters

id

string

The unique identifier of the payment made to the Customer Identifier.

Response Parameters

id

string

The unique identifier of the UPI transfer.

entity

string

The name of the entity. Here, it is upi_transfer.

amount

integer

The amount paid by the customer.

payer_vpa

string

The UPI ID of the customer that is used to make the payment.

payer_bank

string

The name of the customer's bank.

payer_account

string

The bank account number of the customer that is linked to the UPI ID.

payer_ifsc

string

The IFSC associated with the bank account.

payment_id

string

The unique identifier of the payment made by the customer.

npci_reference_id

string

The unique reference number provided by NPCI for the payment.

virtual_account_id

string

The unique identifier of the Customer Identifier.

virtual_account

object

Details of the Customer Identifier.

Show child parameters (12)

Fetch Payments Made Using UPI (Smart Collect 2.0)

GET

/v1/payments/:id/upi_transfer

Click to copy

Use this endpoint to retrieve details of payments made using the UPI payment method.

Watch Out!

Smart Collect APIs are not available in Malaysia.

Is this page helpful?

Path Parameters

id

string

The unique identifier of the payment made to the Customer Identifier.

Response Parameters

id

string

The unique identifier of the UPI transfer.

entity

string

The name of the entity. Here, it is upi_transfer.

amount

integer

The amount paid by the customer.

payer_vpa

string

The UPI ID of the customer that is used to make the payment.

payer_bank

string

The name of the customer's bank.

payer_account

string

The bank account number of the customer that is linked to the UPI ID.

payer_ifsc

string

The IFSC associated with the bank account.

payment_id

string

The unique identifier of the payment made by the customer.

npci_reference_id

string

The unique reference number provided by NPCI for the payment.

virtual_account_id

string

The unique identifier of the Customer Identifier.

virtual_account

object

Details of the Customer Identifier.

Show child parameters (12)

Curl

change language

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

Success

1{
2  "id": "ut_E5YEUKb9yA0YvX",
3  "entity": "upi_transfer",
4  "amount": 100,
5  "payer_vpa": "gauravkumar@exampleupi",
6  "payer_bank": "HDFC BANK LTD",
7  "payer_account": "50100000000001",
8  "payer_ifsc": "HDFC0000004",
9  "payment_id": "pay_E5YETrWuVgP3fI",
10  "npci_reference_id": "001718859181",
11  "virtual_account_id": "va_E5V3Rb3sQaMS5v",
12  "virtual_account": {
13    "id": "va_E5V3Rb3sQaMS5v",
14    "name": "Acme Corp",
15    "entity": "virtual_account",
16    "status": "active",
17    "description": "First Customer Identifier",
18    "amount_expected": null,
19    "notes": [],
20    "amount_paid": 200,
21    "customer_id": "cust_9xnHzNGIEY4TAV",
22    "receivers": [
23      {
24        "id": "vpa_E5V3RsO1g4QK7t",
25        "entity": "vpa",
26        "username": "rpy.payto00000gaurikumari",
27        "handle": "icici",
28        "address": "rpy.payto00000gaurikumari@icici"
29      }
30    ],
31    "close_by": null,
32    "closed_at": null,
33    "created_at": 1579254678
34  }
35}