API Error Responses

HTTP status codes and error response format returned by the Pinch API.

Pinch uses standard HTTP status codes:

  • 2xx — The request succeeded.
  • 4xx — The request failed because of something in your request (bad data, missing fields, authentication failure, etc.).
  • 5xx — Something went wrong on Pinch's side.
Status codeMeaning
200 — OKThe request succeeded.
400 — Bad RequestThe request was rejected because of an invalid or missing field in the request body.
403 — ForbiddenAuthentication failed. Check your access token (the Authorization header) and ensure it hasn't expired.
404 — Not FoundThe requested resource doesn't exist or has been deleted.
500 — Internal Server ErrorSomething went wrong on Pinch's side. Retry after a short delay; if the error persists, contact [email protected].

Error response format

400 responses include a JSON body describing what went wrong:

{
  "errors": [
    {
      "message": "Amount is required and must be greater than zero.",
      "field": "amount"
    }
  ]
}

The field property identifies which request parameter is invalid. Some errors are not field-specific and will return only a message.


What’s Next

Did this page help you?