Skip to main content
POST
Simulate a Card Network Settlement

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required

Idempotency key

Required string length: 5 - 255

Body

application/json

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.

Required string length: 1 - 64
Example:

"123456789"

settlement_date
string<date>
required

The date this network settlement is for.

Example:

"2026-06-01"

currency_code
enum<string>
required

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

Available options:
USD
Example:

"USD"

card_network
enum<string>
required

The card network the settlement came from.

Available options:
visa,
mastercard,
pulse,
accel,
maestro,
tabapay,
amex,
star,
interlink
Example:

"visa"

network_settlement_amount_breakdown
object
required

The gross and net components that make up a card network settlement, in minor units.

Response

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

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.

Required string length: 1 - 64
Example:

"123456789"

settlement_date
string<date>
required

The date this network settlement is for.

Example:

"2026-06-01"

currency_code
enum<string>
required

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

Available options:
USD
Example:

"USD"

card_network
enum<string>
required

The card network the settlement came from.

Available options:
visa,
mastercard,
pulse,
accel,
maestro,
tabapay,
amex,
star,
interlink
Example:

"visa"

network_settlement_amount_breakdown
object
required

The gross and net components that make up a card network settlement, in minor units.