get
https://partner.gupshup.io/partner/bizgate/app//payment//
Returns the current status of a payment attempt on an app, keyed by the payment configuration name and the transaction reference id.
Request parameters
Path parameters
| Key | Description | Values | Data Type | Required/Optional |
|---|---|---|---|---|
| appId | Identifier of the WhatsApp app the call acts on. | 6f414190-d45c-4671-bca1-fb6c3018cb13 | String | Required |
| paymentConfiguration | Name of the payment configuration the reference belongs to. | test-payment-configuration | String | Required |
| referenceId | Payment reference to look up. | ref-90210 | String | Required |
Sample cURL — Payment status check.
curl --request GET \
--url 'https://partner.gupshup.io/partner/bizgate/app/6f414190-d45c-4671-bca1-fb6c3018cb13/payment/test-payment-configuration/ref-90210' \
--header 'Authorization: Bearer <UT>' \
--header 'Accept: application/json'Sample success response (200)
{
"status": "success",
"data": {
"payments": [
{
"reference_id": "order-8f21c4",
"status": "captured",
"currency": "INR",
"amount": {
"value": 21000,
"offset": 100
},
"transactions": [
{
"id": "order_NkQ2Xm4pLd9RtA",
"pg_transaction_id": "pay_NkQ2Yb7sTe1UvB",
"type": "razorpay",
"status": "success",
"created_timestamp": "1721687100",
"updated_timestamp": "1721687287",
"method": {
"type": "upi"
}
}
],
"receipt": "rcpt-2024-07-1183"
}
]
}
}Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…