API Reference
Errors

Errors

Understanding API Responses: TipTop utilizes standard HTTP status codes to communicate the outcome of your API requests.

  • Success (2xx codes): These codes indicate that your API call was processed successfully.
  • Errors (4xx codes): These codes signify issues with your request itself. The response body will contain an error code, an error object, and additional details to help you pinpoint and address the problem. For instance, some 4xx errors (like a declined order) will include a specific error code with a brief explanation.
  • Internal Server Errors (5xx codes): These codes indicate issues on TipTop's end. In such cases, please try your request again later. If the problem persists, contact TipTop support.

This approach ensures clear communication between your system and TipTop's API.

Field Names

KeyTypeDecription
status_codestringHTTP status code.
messagestringA helpful message in plain English about what went wrong.
codestringA concise error code for programmatic identification.
typestringA programmatic error identifier returned by the API.
fieldstringAn incorrect or invalid value.

Status Codes

Status CodesDescription
200Success
400Bad request
401Unauthorized
402Request failed
404Not found
409Conflict
500sInternal Error

Orders endpoint status codes

POST Capture Order

Status CodesError Message
403abc
404abc
409abc

POST Void Order

Status CodesError Message
403abc
404abc
409abc

POST Refund Order

Status CodesError Message
403abc
404abc
409abc