YESBANK collection
Static collection
Create an order, display the returned VPA or QR string, and receive the final payment status through your callback.
State list
Fetch the list of available states for onboarding and other operations.
POST: https://staging.login.tpipay.ai/api/collect-payment/v1/state-list
| Parameter | Type | Required | Description |
|---|---|---|---|
api_token |
String | required | The token used to authenticate the API request. |
Success response
Fetch QR code (create order)
Create an order and fetch the UPI QR or VPA details for collecting payment.
POST: https://staging.login.tpipay.ai/api/collect-payment/v1/createOrder
| Parameter | Type | Required | Description |
|---|---|---|---|
api_token |
String | required | API authentication token. |
sellerIdentifier |
String | required | Unique seller identifier. |
callback_url |
String | optional | URL used for order status updates. |
Success response
Callback
After payment is completed, a server-to-server callback is sent to your configured URL.
POST: https://staging.login.tpipay.ai/example.com/callback
| Parameter | Type | Required | Description |
|---|---|---|---|
status |
string | Yes | Order status; successful transactions are credit. |
amount |
numeric | Yes | Credited amount for the order. |
client_id |
string | Yes | Client identifier. |
order_id |
integer | Yes | Order identifier. |
utr |
string | Yes | Unique Transaction Reference. |
Success response