Payout Status
Post
https://sandbox.transfersmile.com/api/payout/status
Get Payout Status
This endpoint allows you to get payout status.
Parameters
Header
| Content-Type* | string | application/json; chartset=UTF-8 |
| AppId* | string | Get AppId from dashboard |
| Authorization* | string | signature, generated by SHA256($sorted_params + $app_key) |
Body
| payout_id | string | transfersmile transaction id, payout_id or custom_code required. |
| custom_code | string | merchant custom_code, payout_id or custom_code required. |
Responses
| 200 | success |
{
"code": 200,
"msg": "success",
"time": 1628497163,
"data": {
"payout_id": "TPO2108090705014iNqtxektRS",
"custom_code": "custom_code17902976588800",
"status": "PAID",
"description": "success"
}
}
| 400 | custom_code or payout_id required |
{
"code": 400,
"msg": "invalid parameters",
"time": 1628497751,
"data": {
"error": "custom_code or payout_id required"
}
}
| 500 | system error |
{
"code": 500,
"msg": "system error",
"time": 1628497751,
"data": {
"error": "system error"
}
}
Payout Status
| Status | Description |
|---|---|
| IN_PROCESSING | initial status after submitting. |
| PROCESSING | bank processing |
| PAID | payout finished successfully |
| REJECTED | payout rejected by bank |
| REFUNDED | payout refunded by bank |
Tip
By now, both SPEI & transfersmile Wallet supported REFUNDED status.
Example
curl --location --request POST 'https://sandbox.transfersmile.com/api/payout/status' \
--header 'AppId: 94FAC**********************68548' \
--header 'Authorization: d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302' \
--header 'Content-Type: application/json' \
--data-raw '{
"payout_id": "TPO2108090705014iNqtxektRS",
"custom_code": "custom_code17902976588800"
}'
Tip
Note: 94FAC**********************68548 is transfersmile's test merchant id for sandbox, and d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302 is authorization token associated with the test App ID.