Skip to main content

Retrieve a Settlement Account

GET /settlements/{uuId}

Description​

This endpoint retrieves details of a specific settlement account based on the provided UUID.

Required Headers​

TypeDescription
apiKeystring(Required). Wallet API key for authentication. Include in the request header.
Authorizationstring(Required). Authentication token. Include in the request header using the "Bearer" scheme. Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI2NGQ2Nm...

Path Parameters​

NameTypeDescription
uuIdstringSettlement account UUID (Required)

Response Code: 200 - OK​

Description​

Successful.

Response Field​

FieldTypeDescription
statusbooleanIndicates the overall success of the operation.
statusCodeintegerRepresents the specific status code for the response.
messagestringProvides additional information about the response.
dataobjectContains the main data payload of the response.
errorsarrayAn array containing error details if issues occurred.
- messagestringDescribes the error.
- descriptiveMessagestringProvides 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: GET​

>http://20.87.230.105/platform/wallets/settlements/{uuId}

Headers​

Content-TypeValue
apiKey{{apiKey}}

🔑 Authentication bearer​

ParamvalueType
token{{accessCode}}string

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request GET \ 
--url /settlements/{uuId} \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!