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

Request

Curl

Response

Success

Parameters

id mandatory : string The unique identifier of the payment made to the Customer Identifier.

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. id : string The unique identifier of the Customer Identifier. name : string The merchant billing label as it appears on Dashboard. entity : string The name of the entity. Here, it is virtual account. status : string Indicates the status of the Customer Identifier. Possible values are:
  • active
  • closed
description : string A brief description about the Customer Identifier. amount_paid : integer The amount paid by the customer into the Customer Identifier. notes : object Any custom notes added during the creation of the Customer Identifier. customer_id : string The unique identifier of the customer the Customer Identifier is linked with. For more details, refer to the Customers API. receivers : object Configuration of desired receivers for the Customer Identifier. id : string The unique identifier of the virtual UPI ID. For example, vpa_CkTmLXqVYPkbxx. entity : string The name of the entity. Here, it is vpa. username : string The unique identifier which forms the first half of the virtual UPI ID. For example, rpy.payto00000gaurikumari. handle : string The bank name that forms the second half of the virtual UPI ID. For example, icici. address : string The UPI ID that combines the username and the handle with the @ symbol. For example, rpy.payto00000gaurikumari@icici. This parameter appears in the response only when vpa is passed as the receiver type. 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).
Handy Tips 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.