Get_PaymentStatus
Corporate Customers can use this method to check and confirm the transaction status. It will be retrieved using reference id or payment id.
Definition
GET/api/payments/status
Sample Request
| curl -X GET "{{base_URL}}/api/payments/status?Payment_ID&Reference_ID" \ -H "Authorization: Bearer <your_access_token>" \ -H "Content-Type: application/json" |
Request Description
| Parameter Name | Required | Min/Max Length | Type | Remark |
| Authorization | M | Bearer <jwt-token> | String | |
| Reference_ID | C | 6/64 | String | Unique Reference ID used by TB Corporate Customers in Do_Transfer method. • This field can be NULL if Payment ID value is submitted. |
| Payment_ID | C | 14/20 | Numeric | Payment ID generated from Tranglo. • This field can be NULL if Reference ID value is submitted. |
Sample Response
| HTTP 200 OK { "Payment_ID": "B125365123456789", "Reference_ID": "RT123123123213", "Payment_Status": { "Status": "ACCEPTED", "Status_Code": 965, "Sub_Status_Desc": "" }, "StatusUpdateDate": "2025-01-07T14:30:00" } |
Response Description
| Parameter | Data Type | Required | Description |
| Payment_ID | String | M | Payment ID generated by Tranglo. |
| Reference_ID | String | M | Unique Reference ID from TB Corporate Customer. |
| Status | String | M | Transaction Status. |
| Status_Code | Numeric | M | Transaction Status Code. |
| Sub_Status_Desc | String | M | Description of transaction status. |
| StatusUpdateDate | Date | O | Payout datetime. |
M = Mandatory, C = Conditional, O = Optional