Description (Request Settlement)
Request for settlement. (POST)
End Point
https://api.yedpay.com/v1/settlements
Request Header
| # | Key | Value | Description |
|---|---|---|---|
| 1 | Authorization | Bearer {{access_token}} | Login Token |
| 2 | Content-Type | application/x-www-form-urlencoded | x-www-form-urlencoded Format |
Body
| # | Name | Type | Description |
|---|---|---|---|
| 1 | currency | String | Settlement's currency |
| 2 | amount | Numeric String | Settlement's amountMaximum 2 decimal places |
Response
| # | Name | Type | Description |
|---|---|---|---|
| 1 | success | Boolean | Request settlement Success or Fail |
| 2 | message | String | Request settlement Success or Fail Message |
Example Success Response
{
"success": true,
"message": "Settlement Request Accepted"
}
Example Error Response
{
"success": false,
"message": "Unauthenticated.",
"status": 500
}
v1.66.3-20240425 © The Payment Cards Group Limited. All rights reserved.