Get Settlement by Deposit

Get the settlement associated with a specific deposit.

Retrieves the settlement record associated with a specific deposit ID.

Endpoint

GET /v1/settlements/deposit/:depositId

Authentication

Header

Value

x-api-key

Your API key

Path parameters

Parameter

Type

Description

depositId

string

Deposit UUID

Example request

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

const response = await fetch("https://ramp-api.ivorypay.io/api/v1/settlements/deposit/dep-uuid-1", {
  method: "GET",
  headers: {
    "x-api-key": "your_api_key",
  },
});

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

import requests

response = requests.get(
    "https://ramp-api.ivorypay.io/api/v1/settlements/deposit/dep-uuid-1",
    headers={
        "x-api-key": "your_api_key",
    },
)

print(response.json())

package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://ramp-api.ivorypay.io/api/v1/settlements/deposit/dep-uuid-1", nil)
	req.Header.Set("x-api-key", "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

{
  "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",
    "status": "COMPLETED",
    "transactionHash": "0xsettlement123..."
  }
}

Use this endpoint to trace the full lifecycle of a deposit — from fiat receipt to crypto settlement.

PreviousGet Settlement by ID NextList Transactions

Last updated 1 month ago

hashtagEndpoint

hashtagAuthentication

hashtagPath parameters

hashtagExample request

hashtagExample response

Endpoint

Authentication

Path parameters

Example request

Example response