Schedule a pilot

Ingest cleared card settlements

POST/api/v1/credit/card-settlements

Push settled card transactions. Settlements only, never authorisations. Idempotent on the settlement ID, so re-pushing a batch reports duplicates rather than double-counting. A negative amount is a refund.

Operation ID: ingest_card_settlements_api_v1_credit_card_settlements_post·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Request body

Schema: CardSettlementIngestRequest

credit_line_idstring

Target line. Omit when using external_line_id.

external_line_idstring
settlementsarray · CardSettlementIngestItemrequiredCardSettlementIngestItem
7 fields
external_settlement_idstringrequired

Issuer settlement ID. The idempotency key.

settled_onstring · daterequired

Clearing date. Assigns the settlement to a cycle (§10.5).

amount_centsintegerrequired

Signed: positive is a purchase, negative a refund.

merchant_namestring
card_last_fourstring
merchant_category_codestring
descriptionstring

Responses

201Successful Response

Schema: SuccessEnvelope_CardSettlementIngestResponse_

successboolean
messagestring
codestring
dataCardSettlementIngestResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject