Skip to content

API reference

Every public type of Pain001.Sdk, rendered from the XML documentation comments by scripts/api_docs.py. The same comments ship in the package for IDE tooltips.

Type Summary
CheckFinding One problem one rung of the validation ladder found.
CheckResponse The answer to POST /api/v1/check.
FaceInfo One face: a target format a pain.001 document can be projected into.
FaceResponse The answer to POST /api/v1/faces/{face}.
HealthResponse The answer to GET /api/v1/health.
LossReport What a projection carried and what it did not, by indexed path.
MessageTypes The message types the server's MessageType enum lists. Every method takes the message type as a string, so a newer server's types work before this list knows them.
Pain001ApiException The pain001 server answered with a status outside 2xx.
Pain001Client A typed client for the pain001 REST API (pain001 serve).
Pain001ClientOptions Where the pain001 server is and how to reach it.
Pain001GenerationRefusedException The server refused to generate the XML because rows failed validation or a scheme rule: HTTP 422 with success: false (pain001 0.0.87 and later).
Pain001NoDocumentException A generate call answered with a 2xx status but no XML document: success is not true, or xml is missing or empty.
Pain001RawResponse The status and parsed body of a call made with Pain001Client.RequestAsync.
RetryPolicy An opt-in retry policy for the idempotent calls: GET requests only (Pain001Client.HealthAsync, Pain001Client.FacesAsync, and Pain001Client.RequestAsync with GET).
RowError One row-level error in a payment file, in pain001's RowError shape. Not to be confused with ValidationError, the shape of a request rejected with HTTP 422.
UiGenerateResponse The answer to POST /api/v1/ui/generate.
ValidationError One item of an HTTP 422 detail array: FastAPI's request validation error. Deserialize Pain001ApiException.Detail into a list of these when Pain001ApiException.StatusCode is 422. Row errors in a payment file are RowError.
ValidationResponse The answer to POST /api/v1/ui/validate.