API Test Keys

Check Balance of a Payment Source

POST

/v1/upi/tpap/fundsources/:fundsource_id/balance

Click to copy

Use this endpoint to check the balance of a payment source.

Is this page helpful?

Curl

1curl -X POST 'api.rzp.<bank>.com/v1/upi/tpap/fundsources/:fundsource_id/balance' \
2-u [YOUR_KEY_ID]:[YOUR_SECRET] \
3-H "Content-type: application/json" \
4-H "x-device-fingerprint: <device_fingerprint>" \
5-H "x-device-fingerprint-timestamp: 1496918882000" \
6-H "x-customer-reference: customer-id-from-customer" \
7-d '{
8  "upi_credentials":{
9      // credentials received from WebCL 
10  },
11  "upi_transaction_id":"123qwert12",
12  "vpa":"abc@upiexample",
13  "device":{
14    "geocode":"1234.1213",
15    "ip":"198.1.1.1"
16    }
17  }'

Response

1{
2  "entity":"upi.fundsource.balance",
3  "fundsource_id":"string",
4  "currency":"string",
5  "amount":"80000",
6  "customer_reference":"SKALq2p",
7  "upi_transaction_id":"TxnSLALQPl",
8  "vpa":"string",
9  "masked_account_number":"XXXXXXXXX1234",
10  "upi_iin":"12MWKO02"
11}

Query Parameters

fundsource_id

string

The unique identifier of the payment source.

Request Parameters

upi_credentials

string

The encrypted UPI PIN. NPCI credentials is the output from the WebCL page.

upi_transaction_id

string

The unique identifier of the transaction across all entities, created by the originator.

vpa

string

The VPA of the customer requesting the balance.

device

object

Device details.

Show child parameters (2)

Response Parameters

entity

string

Name of the entity.

fundsource_id

string

Unique identifier of the payment source.

currency

string

Currency of the balance.

amount

string

The amount in the lowest denomination of the currency.

customer_reference

string

The customer reference that requested the balance.

upi_transcation_id

string

The transaction ID that brought the balance.

vpa

string

The VPA of the customer.

masked_account_number

string

The masked account number of the customer.

upi_iin

string

UPI Issuer Identification Numbers (upi_iin) of the payment source provider issued by NPCI.

Check Balance of a Payment Source

POST

/v1/upi/tpap/fundsources/:fundsource_id/balance

Click to copy

Use this endpoint to check the balance of a payment source.

Is this page helpful?

Query Parameters

fundsource_id

string

The unique identifier of the payment source.

Request Parameters

upi_credentials

string

The encrypted UPI PIN. NPCI credentials is the output from the WebCL page.

upi_transaction_id

string

The unique identifier of the transaction across all entities, created by the originator.

vpa

string

The VPA of the customer requesting the balance.

device

object

Device details.

Show child parameters (2)

Response Parameters

entity

string

Name of the entity.

fundsource_id

string

Unique identifier of the payment source.

currency

string

Currency of the balance.

amount

string

The amount in the lowest denomination of the currency.

customer_reference

string

The customer reference that requested the balance.

upi_transcation_id

string

The transaction ID that brought the balance.

vpa

string

The VPA of the customer.

masked_account_number

string

The masked account number of the customer.

upi_iin

string

UPI Issuer Identification Numbers (upi_iin) of the payment source provider issued by NPCI.

Curl

1curl -X POST 'api.rzp.<bank>.com/v1/upi/tpap/fundsources/:fundsource_id/balance' \
2-u [YOUR_KEY_ID]:[YOUR_SECRET] \
3-H "Content-type: application/json" \
4-H "x-device-fingerprint: <device_fingerprint>" \
5-H "x-device-fingerprint-timestamp: 1496918882000" \
6-H "x-customer-reference: customer-id-from-customer" \
7-d '{
8  "upi_credentials":{
9      // credentials received from WebCL 
10  },
11  "upi_transaction_id":"123qwert12",
12  "vpa":"abc@upiexample",
13  "device":{
14    "geocode":"1234.1213",
15    "ip":"198.1.1.1"
16    }
17  }'

Response

1{
2  "entity":"upi.fundsource.balance",
3  "fundsource_id":"string",
4  "currency":"string",
5  "amount":"80000",
6  "customer_reference":"SKALq2p",
7  "upi_transaction_id":"TxnSLALQPl",
8  "vpa":"string",
9  "masked_account_number":"XXXXXXXXX1234",
10  "upi_iin":"12MWKO02"
11}