Get Settlement by ID

Get a specific settlement by its ID.

Retrieves the details of a specific settlement.

Endpoint

GET /v1/settlements/:id

Authentication

Header
Value

x-api-key

Your API key

Path parameters

Parameter
Type
Description

id

string

Settlement UUID

Example request

curl -X GET https://ramp-api.ivorypay.io/api/v1/settlements/set-uuid-1 \
  -H "x-api-key: your_api_key"

Example response

{
  "statusCode": 200,
  "success": true,
  "message": "Query successful",
  "data": {
    "id": "set-uuid-1",
    "reference": "set_abc123",
    "depositId": "dep-uuid-1",
    "fiatAmount": 99500,
    "fiatCurrency": "NGN",
    "cryptoAmount": 62.18,
    "token": "USDT",
    "chain": "BSC_MAINNET",
    "destinationAddress": "0xYourWallet...",
    "conversionRate": 1600,
    "platformFee": 0.31,
    "businessFee": 0,
    "gasFee": 0.5,
    "transactionHash": "0xsettlement123...",
    "status": "COMPLETED"
  }
}

Last updated