Simulation

Simulate a Card Network Settlement

Changed on Nov 3, 2026

Simulate a Card Network Settlement for your program, as if Lead received the settlement file from the network, and trigger the related downstream behavior. A Card Network Settlement cannot be created twice for the same settlement reporting ID, settlement_date, currency_code, and card_network. Available in Sandbox only.

post/v2/simulate/card_network_settlements

Request

Base URL
https://api.sandbox.lead.bank
URL
https://api.sandbox.lead.bank/v2/simulate/card_network_settlements
Auth
HTTP bearer

Headers

Idempotency-Keystring required

Idempotency key

Request body

settlement_reporting_idstring required

In Sandbox this is not checked against your program's configuration and does not have to match a production reporting ID; any non-empty value is accepted.

settlement_datestring date required

The date this network settlement is for.

currency_code'USD' required

A three-letter currency code as defined in ISO 4217.

The card network the settlement came from.

Example request

{
  "settlement_reporting_id": "123456789",
  "settlement_date": "2026-06-01",
  "currency_code": "USD",
  "card_network": "visa",
  "network_settlement_amount_breakdown": {
    "transactions": 250000,
    "refunds": -5000,
    "interchange": -3000,
    "fees": 1200,
    "disputes": -800
  }
}

Response

The card network settlement was accepted. The response echoes the settlement that was submitted; it is not the full Card Network Settlement record.