Record a fact only the participant knows
Records version 1 of a fact that only your institution knows, for the APIX001 report of a month. fact_type in the path selects the body, and the factType of the body must have the same value (422, PIX-0723).
The route accepts OUTSIDE_SPI_SETTLEMENT, OUTSIDE_SPI_REFUND, OUTBOUND_FRAUD_REFUSAL and DICT_SCREEN_STEP. The same clientRequestId with the same content creates nothing and answers the fact already recorded. The same clientRequestId with other content answers 409 (PIX-0717): correct the fact with the correct route. A new clientRequestId for a subject that already has a current fact of the same type answers 409 (PIX-0725). An OUTSIDE_SPI_REFUND needs a reasonCode of FR01, MD06, SL02 or BE08, or the route answers 422 (PIX-0726). FR01 counts as fraud (refundDetail 1). The other three count as other (refundDetail 2).
A fact for a closed month is accepted. It enters a report only after a reopen and a new close.
Pix Lerian limits recording and correcting facts to 2 in flight for each tenant on each serving instance. Above that, the route answers 429 (PIX-0006) with Retry-After and records nothing. Send a backfill one request at a time.
Headers
REQUIRED. Client-supplied replay key, at most 64 bytes. A request without it is refused with PIX-0030 @ 400 before the handler runs. An identical resend within 1 hour returns the original response, status included, with X-Idempotency-Replayed: true. Reusing the key with a divergent method, URL or body is PIX-0031 @ 412.
1 - 64Path Parameters
Fact type, the same value as the factType of the body. One of OUTSIDE_SPI_SETTLEMENT, OUTSIDE_SPI_REFUND, OUTBOUND_FRAUD_REFUSAL or DICT_SCREEN_STEP. Any other value is refused.
OUTBOUND_FRAUD_REFUSAL, OUTSIDE_SPI_SETTLEMENT, OUTSIDE_SPI_REFUND, DICT_SCREEN_STEP "OUTSIDE_SPI_REFUND"
Body
- Option 1
- Option 2
- Option 3
- Option 4
Fact body, one schema per fact type chosen by factType.
Response
Created

