Settlements

Track Settlement activity

List settlements

get

/api/v1/settlements

Authorizations

x-api-keystringRequired

Your API key (obtain from dashboard)

Query parameters

pagenumber · min: 1Optional

Page number (1-based)

Default: 1Example: 1

sizenumber · min: 1 · max: 100Optional

Items per page

Default: 10Example: 10

entitystring · enumOptional

Filter by entity type

Possible values:

currencystring · enumOptional

Filter by settlement currency

Possible values:

Responses

200

Settlements retrieved successfully

application/json

successbooleanRequired

Indicates if the request was successful

Example: true

messagestringRequired

Response message

Example: Success

401

Unauthorized

get/api/v1/settlements

GET /api/v1/settlements HTTP/1.1
Host: api.coincircuit.io
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "message": "Success",
  "data": [
    {
      "status": "completed",
      "entity": "session",
      "reference": "cs-mp9rm032-flh1obsqjpv",
      "balanceReference": "DEP-MP9RZA2D-9AEBQ1",
      "requested": {
        "amount": "5000.00",
        "currency": "NGN"
      },
      "gross": {
        "currency": "NGN",
        "amount": "10000",
        "conversionRate": "1464.96"
      },
      "customerPaid": {
        "amount": "222.000"
      },
      "fees": {
        "processing": {
          "amount": "17.760",
          "paidBy": "merchant"
        },
        "gas": {
          "amount": "17.760",
          "paidBy": "merchant"
        }
      },
      "net": {
        "amount": "222.000"
      }
    }
  ],
  "meta": {
    "page": 1,
    "size": 10,
    "total": 42,
    "totalPages": 5
  }
}

Retrieve settlement data

get

/api/v1/settlements/{reference}

Authorizations

x-api-keystringRequired

Your API key (obtain from dashboard)

Path parameters

referencestringRequired

Session or invoice reference

Example: cs_ref_abc123xyz789

Query parameters

entitystring · enumRequired

Entity type

Possible values:

Responses

200Success

application/json

successbooleanRequired

Indicates if the request was successful

Example: true

messagestringRequired

Response message

Example: Success

400

Missing or invalid "entity" query parameter

401

Unauthorized

404

Session or invoice not found

get/api/v1/settlements/{reference}

GET /api/v1/settlements/{reference}?entity=session HTTP/1.1
Host: api.coincircuit.io
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "message": "Success",
  "data": {
    "status": "completed",
    "entity": "session",
    "reference": "cs-mp9rm032-flh1obsqjpv",
    "balanceReference": "DEP-MP9RZA2D-9AEBQ1",
    "requested": {
      "amount": "5000.00",
      "currency": "NGN"
    },
    "gross": {
      "currency": "NGN",
      "amount": "10000",
      "conversionRate": "1464.96"
    },
    "customerPaid": {
      "amount": "222.000"
    },
    "fees": {
      "processing": {
        "amount": "17.760",
        "paidBy": "merchant"
      },
      "gas": {
        "amount": "17.760",
        "paidBy": "merchant"
      }
    },
    "net": {
      "amount": "222.000"
    }
  }
}