List Settlements

List all settlements for your business.

Returns all settlements (fiat-to-crypto conversions from deposits) for your business.

Endpoint

GET /v1/settlements

Authentication

Header	Value
x-api-key	Your API key

Query parameters

Parameter	Type	Required	Description
startPeriodDatetime	string	No	Start of date range (ISO 8601)
endPeriodDatetime	string	No	End of date range (ISO 8601)
page	number	No	Page number (default: 1)
limit	number	No	Items per page (default: 20)

Example request

cURL

curl -X GET "https://ramp-api.ivorypay.io/api/v1/settlements?page=1&limit=10" \
  -H "x-api-key: your_api_key"

Node.js

Python

Go

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",
      "createdAt": "2026-03-26T15:00:00.000Z"
    }
  ],
  "meta": {
    "total": 15,
    "page": 1,
    "limit": 10,
    "totalPages": 2
  }
}

Settlement statuses

Status	Description
AWAITING_SETTLEMENT_ACCOUNT	Waiting for settlement account configuration
CONVERTING	Fiat-to-crypto conversion in progress
PAYOUT_INITIATED	Crypto payout has been queued
PAYOUT_PROCESSING	Crypto is being sent on-chain
COMPLETED	Crypto delivered to your wallet
FAILED	Settlement failed