Update Settlement Account
PUT /settlements
Description
Retrieve settlement account information based on specified criteria. This endpoint allows users to obtain details about settlement accounts.
Parameters:
| Name | Type | Description | Required/Optional |
|---|---|---|---|
| countryCode | string | The country code. | Required |
| tenantId | string | The identifier for the tenant. | Required |
| userId | string | The user identifier. | Required |
StartFragment
Response Code: 200 - OK
Description
Successful.
Response Field
| Field | Type | Description |
|---|---|---|
| status | boolean | Indicates the overall success of the operation. |
| statusCode | integer | Represents the specific status code for the response. |
| message | string | Provides additional information about the response. |
| data | object | Contains the main data payload of the response. |
| errors | array | An array containing error details if issues occurred. |
| - message | string | Describes the error. |
| - descriptiveMessage | string | Provides a more detailed and descriptive message about the error. |
Example
<response>
<status>true</status>
<statusCode>0</statusCode>
<message>string</message>
<data></data>
<errors>
<error>
<message>string</message>
<descriptiveMessage>string</descriptiveMessage>
</error>
</errors>
</response>
Method: PUT
>http://20.87.230.105/platform/wallets/settlements
Headers
| Content-Type | Value |
|---|---|
| apiKey | {{apiKey}} |
Body (raw)
{
"recipientName": "string",
"recipientBankCode": "string",
"recipientAccountNumber": "stringstri",
"uuId": "string",
"userId": "string"
}
🔑 Authentication bearer
| Param | value | Type |
|---|---|---|
| token | {{accessCode}} | string |
LANGUAGE
CURL REQUEST
curl --request PUT \
--url /settlements \
--header 'accept: application/json' \
--header 'content-type: application/json'
RESPONSE
Click Try It! to start a request and see the response here!