Naar de inhoud gaan
RemindCash

Fout bij het afhandelen

Het foutformaat, elke statuscode die de API retourneert en hoe verzoeken ID's te gebruiken.

Openbare API-status

De v1 API maakt gebruik van company-scoped toonder keys en vereist een actieve planning periode. Ontwerp en betaling rapportage eindpunten niet verzenden klantenberichten. Voorbeelden gebruiken plaatshouders .Plakken nooit een echte sleutel in gedeelde code.

Foutopmaak

Elke fout heeft dezelfde JSON vorm:

JSON
{
    "error": {
        "code": "not_found",
        "message": "Resource not found."
    },
    "request_id": "9fd120d8-f54e-4413-bc52-a860800ff222"
}

Validatiefouten voegen een fields-object toe met berichten per veld:

JSON
{
    "error": {
        "code": "validation_failed",
        "message": "Validation failed.",
        "fields": {
            "currency": ["The selected currency is invalid."],
            "due_date": ["The due date field is required."]
        }
    },
    "request_id": "89a24d53-684a-4e1d-b0ee-2f6a5a7cd2c2"
}

Foutantwoorden omvatten nooit stack sporen, geheimen of gegevens van andere bedrijven.

Statuscodes

Status error.code Wanneer
401 unauthenticated Ontbrekende, ongeldige of verlopen API-sleutel.
403 forbidden De sleutel mist het toepassingsgebied, of de belangrijkste eigenaar, lidmaatschap of bedrijf is niet in aanmerking komen.
404 not_found De bron bestaat niet or behoort tot een ander bedrijf.
409 conflict Idempotency key hergebruikt met een andere body, oude expected_version, dupliceren external_reference, of een draft-only verandering op een niet-ontwerp te ontvangen.
422 validation_failed Een veld ontbreekt of is ongeldig, de Idempotency-Key ontbreekt, of een statuswijziging is niet toegestaan.
429 rate_limited Te veel verzoeken .. zie Rate limits.
500 server_error Er ging iets mis aan onze kant. Probeer het later met dezelfde Idempotency-Key.

ID's aanvragen

Elke reactie heeft een X-Request-Id header. Foutantwoorden en leesreacties omvatten het ook als request_id in het lichaam. Voeg het toe wanneer u contact opneemt met ondersteuning zodat het verzoek kan worden getraceerd.

Veilig opnieuw proberen

  • Probeer 429, 500 en netwerkfouten met backoff.
  • Voor schrijfsels, probeer het opnieuw met de Same Idempotency-Key en de Same body; je krijgt het originele resultaat in plaats van een duplicaat.
  • Probeer 4xx-validatie of conflictfouten niet opnieuw .