1. order info
https://domain/api/pay/pay_info
1.1) request body
| name | type | necessary | remark |
|---|---|---|---|
| id | string | Y | order ID |
| href | string | N | href |
| referrer | string | N | referrer |
1.2) response body
| name | type | remark |
|---|---|---|
| time | long | response timestamp |
| status | string | error code: 0 is success, Non-zero is error code |
| message | string | error message when error code is non-zero |
| model | T | bussiness entity |
T description
| name | type | remark |
|---|---|---|
| id | string | order id |
| status | string | order status:PENDING/SUCCESS |
| amount | string | order amount |
| cardInfo | T | card info |
| upiId | string | upi id |
| deeplink | string | deeplink/qrcode data |
| successUrl | string | optional, redirect successUrl after paid success |
cardInfo
| name | type | remark |
|---|---|---|
| name | string | name |
2. generate discount amount (in case of invoking phonepe)
https://domain/api/pay/generate_discount
2.1) request body
| name | type | necessary | remark |
|---|---|---|---|
| id | string | Y | order ID |
2.2) response body
| name | type | remark |
|---|---|---|
| time | long | response timestamp |
| status | string | error code: 0 is success, Non-zero is error code |
| message | string | error message when error code is non-zero |
| model | T | bussiness entity |
T description
| name | type | remark |
|---|---|---|
| id | string | order id |
| status | string | order status:PENDING/SUCCESS |
| amount | string | order amount |
| userPayAmount | string | user need to pay amount |
| discountAmount | string | discount amount |
3. pay result (query pay status interval 5s)
https://domain/api/pay/pay_result
3.1) request body
| name | type | necessary | remark |
|---|---|---|---|
| id | string | Y | order ID |
3.2) response body
| name | type | remark |
|---|---|---|
| time | long | response timestamp |
| status | string | error code: 0 is success, Non-zero is error code |
| message | string | error message when error code is non-zero |
| model | T | bussiness entity |
T description
| name | type | remark |
|---|---|---|
| id | string | order id |
| status | string | order status:PENDING/SUCCESS |
| amount | string | order amount |
| cardInfo | T | card info |
| upiId | string | upi id |
| deeplink | string | deeplink/qrcode data |
| successUrl | string | optional, redirect successUrl after paid success |
cardInfo
| name | type | remark |
|---|---|---|
| name | string | name |
4. pay event (event tracking)
https://domain/api/pay/pay_event
4.1) request body
| name | type | necessary | remark |
|---|---|---|---|
| id | string | Y | order ID |
| event | string | Y | OPEN_LINK/SUBMIT_UTR/INVOKE_APP/COPY |
| content | string | N | content, eg. OPEN_LINK phonepe://pay?pa=boim-561518330444%40boi&pn=SRINIVASA%20TRADERS&tn=BJAA6Z&am=100&mam=100&cu=INR |
4.2) response body
| name | type | remark |
|---|---|---|
| time | long | response timestamp |
| status | string | error code: 0 is success, Non-zero is error code |
| message | string | error message when error code is non-zero |
| model | T | bussiness entity |
5. submit utr
https://domain/api/pay/submit_utr
5.1) request body
| name | type | necessary | remark |
|---|---|---|---|
| id | string | Y | order ID |
| userUtrNo | string | Y | UTR NO |
5.2) response body
| name | type | remark |
|---|---|---|
| time | long | response timestamp |
| status | string | error code: 0 is success, Non-zero is error code |
| message | string | error message when error code is non-zero |
| model | T | bussiness entity |
T description
| name | type | remark |
|---|---|---|
| id | string | order id |
| status | string | order status:PENDING/SUCCESS |
| amount | string | order amount |
| successUrl | string | optional, redirect successUrl after paid success |