API Reference

Create UPI Collect Request

post
https://api-uat.ncome.in/api/v1/qr/collect

This API is used to create a UPI Collect request (intent pull request) to a specific VPA for a specified amount and expiry time. Once created, the collect request is sent to the user's UPI app for approval.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Amount to be collected via UPI (must be a valid decimal string, e.g., "1.01")

string
required

Payer's UPI VPA to whom the collect request is sent (e.g., abc@upi)

string
required

Name of the payer (shown in UI/reporting)

string
required

Expiry time for the collect request in epoch milliseconds

string
required

Note or purpose for the transaction (e.g., "UPI col")

string
required
Defaults to upi_collect

Type of UPI request. Must be "upi_collect"

Headers
string
Defaults to {{X-Client-Key}}

API key generated from Castler dashboard

string
Defaults to {{x-api-key}}

xAPI key shared separately by Castler

Response

Updated 11 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago

Did this page help you?