--- title: "Simulate a Card Network Settlement" method: POST path: "/v2/simulate/card_network_settlements" tags: ["Simulation"] --- # Simulate a Card Network Settlement `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 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. ## Headers - `Idempotency-Key` string, required ## Request body - SimulatedNetworkSettlement: A card network settlement submitted to the simulation endpoint. When returned, this echoes the values that were submitted; it is not the full Card Network Settlement record. - `settlement_reporting_id` string, 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_date` string, date, required: The date this network settlement is for. - `currency_code` 'USD', required: A three-letter currency code as defined in ISO 4217. - `card_network` 'visa' | 'mastercard' | 'pulse' | 'accel' | 'maestro' | 'tabapay' | 'amex' | 'star' | 'interlink', required: The card network the settlement came from. - `network_settlement_amount_breakdown` NetworkSettlementAmountBreakdown, required: The gross and net components that make up a card network settlement, in minor units. - `transactions` integer, required: Gross transactions that settled on the network — funds spent by cardholders, in aggregate, in minor units. For credit programs this is the amount that drives receivable creation. - `refunds` integer, required: Gross refunds that settled on the network — funds returned to cardholders, in aggregate, in minor units. Zero or negative. - `interchange` integer, required: Net interchange that settled on the network, in minor units. May be positive or negative. - `fees` integer, required: Net fees that settled on the network, in minor units. May be positive or negative. - `disputes` integer, required: Net disputes that settled on the network, in minor units. May be positive or negative. ## Response `200` The card network settlement was accepted. The response echoes the settlement that was submitted; it is not the full Card Network Settlement record. - SimulatedNetworkSettlement: A card network settlement submitted to the simulation endpoint. When returned, this echoes the values that were submitted; it is not the full Card Network Settlement record. - `settlement_reporting_id` string, 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_date` string, date, required: The date this network settlement is for. - `currency_code` 'USD', required: A three-letter currency code as defined in ISO 4217. - `card_network` 'visa' | 'mastercard' | 'pulse' | 'accel' | 'maestro' | 'tabapay' | 'amex' | 'star' | 'interlink', required: The card network the settlement came from. - `network_settlement_amount_breakdown` NetworkSettlementAmountBreakdown, required: The gross and net components that make up a card network settlement, in minor units. - `transactions` integer, required: Gross transactions that settled on the network — funds spent by cardholders, in aggregate, in minor units. For credit programs this is the amount that drives receivable creation. - `refunds` integer, required: Gross refunds that settled on the network — funds returned to cardholders, in aggregate, in minor units. Zero or negative. - `interchange` integer, required: Net interchange that settled on the network, in minor units. May be positive or negative. - `fees` integer, required: Net fees that settled on the network, in minor units. May be positive or negative. - `disputes` integer, required: Net disputes that settled on the network, in minor units. May be positive or negative. ## Other responses - `400`: The request could not be parsed (`request_malformed`), or the `Idempotency-Key` header is missing (`idempotency_key_missing`). - `403`: Rejected before the request reached the Receivable API. `code` is one of: `authentication_missing` (the request has no credentials), `token_invalid` (the bearer token is expired, invalid, or does not grant the required scope), `source_ip_not_permitted` (the request came from an IP address that is not on your program's allowlist). - `404`: This endpoint is not available outside the Sandbox environment. - `409`: A concurrent request with the same `Idempotency-Key` is still in flight. - `422`: The request was parsed but cannot be processed. `code` is one of: `parameters_invalid` (a field is missing, malformed, or out of range; all failures returned at once), `related_object_invalid` (the `card_network` and `currency_code` combination does not match a network configured for your program), `object_state_mismatched` (a network settlement already exists for this `settlement_reporting_id`, `card_network`, `settlement_date`, and `currency_code`), `idempotency_request_mismatched` (this `Idempotency-Key` was used with a different request body). - `429`: Rate limit exceeded. - `500`: Internal server error. ## Changes - **2026-11-03** `2c659854496e`: 1 info - endpoint added [Operation history](https://skmtc.dev/lead/apis/lead-bank/changes/v2/simulate/card_network_settlements/post.md) --- [API](https://skmtc.dev/lead/apis/lead-bank.md) - [All operations](https://skmtc.dev/lead/apis/lead-bank/llms.txt) - [OpenAPI document](https://skmtc.dev/lead/apis/lead-bank/revisions/2c659854496e?raw)