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
Authorization	Your API key

Query parameters

None currently supported (subject to change).

Example request

cURL

curl -X GET "https://ramp-api.ivorypay.io/api/v1/settlements" \
  -H "Authorization: your_api_key"

Node.js

const response = await fetch("https://ramp-api.ivorypay.io/api/v1/settlements", {
  method: "GET",
  headers: {
    "Authorization": "your_api_key",
  },
});

const data = await response.json();
console.log(data);

Python

import requests

response = requests.get(
    "https://ramp-api.ivorypay.io/api/v1/settlements",
    headers={
        "Authorization": "your_api_key",
    },
)

print(response.json())

Go

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://ramp-api.ivorypay.io/api/v1/settlements", nil)
	req.Header.Set("Authorization", "your_api_key")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

Example response

The settlement entity does not have its own reference column — the human-readable reference lives on the joined deposit record (accessible as deposit.reference when the relation is loaded).

{
  "success": true,
  "message": "Settlements retrieved",
  "data": [
    {
      "id": "set-uuid-1",
      "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"
    }
  ]
}

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