Fetch Payments for a Customer Identifier

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

RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

String virtualId = "va_DlGmm7jInLudH9";

JSONObject params = new JSONObject();
params.put("count","1");

List<VirtualAccount> virtualaccounts = instance.virtualAccounts.fetchPayments(virtualId,params);

import razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.virtual_account.payments(virtualId,options)

require "razorpay"
Razorpay.setup('key_id', 'key_secret')

virtualId = "va_IDDYE8gYTLJCEH"

options = {"count":1}

Razorpay::VirtualAccount.fetch(virtualId).payments(options)

$api = new Api($key_id, $secret);

$api->virtualAccount->fetch($virtualId)->payments($options);

var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.virtualAccounts.fetchPayments(virtualId,options)

import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

body, err := client.VirtualAccount.Payments("<virtualId>", nil, nil)

require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

virtualId = "va_IDDYE8gYTLJCEH"

options = {"count":1}

Razorpay::VirtualAccount.fetch(virtualId).payments(options)

RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]

string virtualId = "va_Z6t7VFTb9xHeOs";

Dictionary<string, object> param = new Dictionary<string, object>();
param.Add("count","1");

List<Payment> virtualaccount = client.VirtualAccount.Fetch(virtualId).Payments(param);

razorpay smart-collect payments va_DlGmm7jInLudH8

{
  "entity": "collection",
  "count": 1,
  "items": [
    {
      "id": "pay_JGmL38CqCHTyZZ",
      "entity": "payment",
      "amount": 1000,
      "currency": "INR",
      "status": "captured",
      "order_id": null,
      "invoice_id": null,
      "international": false,
      "method": "upi",
      "amount_refunded": 0,
      "refund_status": null,
      "captured": true,
      "description": null,
      "card_id": null,
      "bank": null,
      "wallet": null,
      "vpa": "gaurav.kumar@exampleupi",
      "email": "gaurav.kumar@example.com",
      "contact": "+919000090000",
      "customer_id": "cust_HWj3MjySAHSjtq",
      "notes": [],
      "fee": 12,
      "tax": 2,
      "error_code": null,
      "error_description": null,
      "error_source": null,
      "error_step": null,
      "error_reason": null,
      "acquirer_data": {
        "rrn": "209817848101"
      },
      "created_at": 1649402719
    }
  ]
}

{
  "error": {
    "code": "BAD_REQUEST_ERROR",
    "description": "The api key provided is invalid",
    "source": "NA",
    "step": "NA",
    "reason": "NA",
    "metadata": {}
  }
}

GET

virtual_accounts

:id

payments

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

RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

String virtualId = "va_DlGmm7jInLudH9";

JSONObject params = new JSONObject();
params.put("count","1");

List<VirtualAccount> virtualaccounts = instance.virtualAccounts.fetchPayments(virtualId,params);

import razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.virtual_account.payments(virtualId,options)

require "razorpay"
Razorpay.setup('key_id', 'key_secret')

virtualId = "va_IDDYE8gYTLJCEH"

options = {"count":1}

Razorpay::VirtualAccount.fetch(virtualId).payments(options)

$api = new Api($key_id, $secret);

$api->virtualAccount->fetch($virtualId)->payments($options);

var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.virtualAccounts.fetchPayments(virtualId,options)

import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

body, err := client.VirtualAccount.Payments("<virtualId>", nil, nil)

require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

virtualId = "va_IDDYE8gYTLJCEH"

options = {"count":1}

Razorpay::VirtualAccount.fetch(virtualId).payments(options)

RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]

string virtualId = "va_Z6t7VFTb9xHeOs";

Dictionary<string, object> param = new Dictionary<string, object>();
param.Add("count","1");

List<Payment> virtualaccount = client.VirtualAccount.Fetch(virtualId).Payments(param);

razorpay smart-collect payments va_DlGmm7jInLudH8

{
  "entity": "collection",
  "count": 1,
  "items": [
    {
      "id": "pay_JGmL38CqCHTyZZ",
      "entity": "payment",
      "amount": 1000,
      "currency": "INR",
      "status": "captured",
      "order_id": null,
      "invoice_id": null,
      "international": false,
      "method": "upi",
      "amount_refunded": 0,
      "refund_status": null,
      "captured": true,
      "description": null,
      "card_id": null,
      "bank": null,
      "wallet": null,
      "vpa": "gaurav.kumar@exampleupi",
      "email": "gaurav.kumar@example.com",
      "contact": "+919000090000",
      "customer_id": "cust_HWj3MjySAHSjtq",
      "notes": [],
      "fee": 12,
      "tax": 2,
      "error_code": null,
      "error_description": null,
      "error_source": null,
      "error_step": null,
      "error_reason": null,
      "acquirer_data": {
        "rrn": "209817848101"
      },
      "created_at": 1649402719
    }
  ]
}

{
  "error": {
    "code": "BAD_REQUEST_ERROR",
    "description": "The api key provided is invalid",
    "source": "NA",
    "step": "NA",
    "reason": "NA",
    "metadata": {}
  }
}

Use this endpoint to retrieve payment details for a single Customer Identifier by id.

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

RazorpayClient razorpay = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]");

String virtualId = "va_DlGmm7jInLudH9";

JSONObject params = new JSONObject();
params.put("count","1");

List<VirtualAccount> virtualaccounts = instance.virtualAccounts.fetchPayments(virtualId,params);

import razorpay
client = razorpay.Client(auth=("YOUR_ID", "YOUR_SECRET"))

client.virtual_account.payments(virtualId,options)

require "razorpay"
Razorpay.setup('key_id', 'key_secret')

virtualId = "va_IDDYE8gYTLJCEH"

options = {"count":1}

Razorpay::VirtualAccount.fetch(virtualId).payments(options)

$api = new Api($key_id, $secret);

$api->virtualAccount->fetch($virtualId)->payments($options);

var instance = new Razorpay({ key_id: 'YOUR_KEY_ID', key_secret: 'YOUR_SECRET' })

instance.virtualAccounts.fetchPayments(virtualId,options)

import ( razorpay "github.com/razorpay/razorpay-go" )
client := razorpay.NewClient("YOUR_KEY_ID", "YOUR_SECRET")

body, err := client.VirtualAccount.Payments("<virtualId>", nil, nil)

require "razorpay"
Razorpay.setup('YOUR_KEY_ID', 'YOUR_SECRET')

virtualId = "va_IDDYE8gYTLJCEH"

options = {"count":1}

Razorpay::VirtualAccount.fetch(virtualId).payments(options)

RazorpayClient client = new RazorpayClient("[YOUR_KEY_ID]", "[YOUR_KEY_SECRET]

string virtualId = "va_Z6t7VFTb9xHeOs";

Dictionary<string, object> param = new Dictionary<string, object>();
param.Add("count","1");

List<Payment> virtualaccount = client.VirtualAccount.Fetch(virtualId).Payments(param);

razorpay smart-collect payments va_DlGmm7jInLudH8

{
  "entity": "collection",
  "count": 1,
  "items": [
    {
      "id": "pay_JGmL38CqCHTyZZ",
      "entity": "payment",
      "amount": 1000,
      "currency": "INR",
      "status": "captured",
      "order_id": null,
      "invoice_id": null,
      "international": false,
      "method": "upi",
      "amount_refunded": 0,
      "refund_status": null,
      "captured": true,
      "description": null,
      "card_id": null,
      "bank": null,
      "wallet": null,
      "vpa": "gaurav.kumar@exampleupi",
      "email": "gaurav.kumar@example.com",
      "contact": "+919000090000",
      "customer_id": "cust_HWj3MjySAHSjtq",
      "notes": [],
      "fee": 12,
      "tax": 2,
      "error_code": null,
      "error_description": null,
      "error_source": null,
      "error_step": null,
      "error_reason": null,
      "acquirer_data": {
        "rrn": "209817848101"
      },
      "created_at": 1649402719
    }
  ]
}

{
  "error": {
    "code": "BAD_REQUEST_ERROR",
    "description": "The api key provided is invalid",
    "source": "NA",
    "step": "NA",
    "reason": "NA",
    "metadata": {}
  }
}

Path Parameters

string

required

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

Query Parameters

integer

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

integer

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

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.

integer

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

Response Parameters

string

Unique identifier of the payment.

string

Indicates the type of entity.

integer

The payment amount in currency subunits. For example, for an amount of ₹1 enter 100.

string

The currency in which the payment is made.

string

The status of the payment. Possible values:

created
authorized
captured
refunded
failed

string

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

card
netbanking
wallet
emi
upi

string

Order id, if provided. Know more about Orders.

string

Description of the payment, if any.

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.

string

The refund status of the payment. Possible values:

null
partial
full

integer

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

boolean

Indicates if the payment is captured. Possible values:

true: Payment has been captured.
false: Payment has not been captured.

string

Customer email address used for the payment.

string

Customer contact number used for the payment.

integer

Fee (including GST) charged by Razorpay.

integer

GST charged for the payment.

string

Error that occurred during payment. For example, BAD_REQUEST_ERROR.

string

Description of the error that occurred during payment. For example, Payment processing failed because of incorrect OTP.

string

The point of failure. For example, customer.

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.

string

The exact error reason. For example, incorrect_otp.

json object

Contains user-defined fields, stored for reference purposes.

integer

Timestamp, in UNIX format, on which the payment was created.

string

The unique identifier of the card used by the customer to make the payment.

object

Details of the card used to make the payment.

string

The unique identifier of the card used by the customer to make the payment.

string

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

string

Name of the cardholder.

integer

The last 4 digits of the card number.

string

The card network. Possible values:

American Express
Diners Club (Only available for private limited and registered businesses)
Maestro
MasterCard
RuPay
Unknown
Visa

string

The card type. Possible values:

credit
debit
prepaid
unknown

string

The card issuer. The 4-character code denotes the issuing bank.

Handy TipsThis attribute will not be set for the card issued by a foreign bank.

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.

string

The sub-type of the customer’s card. Possible values:

customer
business

Handy TipsKnow how to accept payments made by customers using corporate cards.

object

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

string

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

bank_account
credit_card
wallet

string

The customer’s VPA (Virtual Payment Address) or UPI id used to make the payment. For example, gauravkumar@exampleupi.

string

The type of UPI flow. Possible value in_app.

Handy TipsThe field flow is present only in the case of Turbo UPI Payments.

string

The 4-character bank code which the customer’s account is associated with. For example, UTIB for Axis Bank.

string

The customer’s VPA (Virtual Payment Address) or UPI id used to make the payment. For example, gauravkumar@exampleupi.

string

The name of the wallet used by the customer to make the payment. For example, payzapp.

array

A dynamic array consisting of a unique reference numbers.

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.

string

A unique reference number generated for RuPay card payments.

string

A unique reference number provided by the banking partner in case of netbanking payments.

Errors

The API `<key/secret> ` provided is invalid.

Code: 4xxOccurs 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.

Partners

Payout APIs

Fetch Payments for a Customer Identifier

Path Parameters

Query Parameters

Response Parameters

Errors

​Path Parameters

​Query Parameters

​Response Parameters

​Errors

Path Parameters

Query Parameters

Response Parameters

Errors