Skip to main content

Documentación

Support Ticket Errors

This API documents the 200 response for each operation. The API can return the following errors instead. Errors use the same envelope as a successful response, with status.status set to ERROR and the code in status.error_code.

Errors for all ticket endpoints

Error Code

Message

UNAUTHENTICATED_API_CALL (HTTP 401)

The signature or access key is missing or not valid.

None (empty body) (HTTP 404)

The API is not enabled for the organization.

ERROR_<ACTION>_SUPPORT_TICKET (HTTP 500)

The support system or an internal call failed. See the action names for each endpoint below.

Upload attachment

Error Code

Message

ERROR_UPLOAD_FILE_UNSUPPORTED_FILE_TYPE (HTTP 400)

The file type is not allowed.

ERROR_UPLOAD_FILE_SIZE_TO_LARGE (HTTP 400)

The file is larger than the size limit. The exact code can differ, because it comes from the upload library.

ERROR_TOO_MANY_FILES_IN_UPLOAD_REQUEST (HTTP 400)

The request contains more than one file.

ERROR_UPLOAD_BATCH_FILE (HTTP 400)

The request has no file, or the upload failed.

UNAUTHENTICATED_API_CALL, MISSING_AUTHENTICATION_HEADERS (HTTP 401)

Authentication failed.

NOT_FOUND (HTTP 404)

The upload is not enabled for the organization.

Get ticket options

Error Code

Message

ERROR_GET_SUPPORT_TICKET_OPTIONS (HTTP 500)

The support system or an internal call failed.

Create ticket

Error Code

Message

MISSING_FIELDS - [FIELD, ...] (HTTP 400)

A required field is missing.

INVALID_FIELD - [FIELD] (HTTP 400)

A value is outside the allowed options, the subject is not valid for the category and environment, you send token for a category that does not accept it, an email or merchant ID has a bad format, or a field is over its length limit.

ERROR_SUPPORT_TICKET_INVALID_ATTACHMENT (HTTP 400)

A token has a bad format, is unknown, belongs to another organization, or is not a support ticket attachment.

ERROR_SUPPORT_TICKET_ATTACHMENT_TYPE_NOT_ALLOWED (HTTP 400)

The file extension is not allowed, or the file content does not match it.

ERROR_SUPPORT_TICKET_ATTACHMENT_TOO_LARGE (HTTP 400)

A file is larger than the size limit.

ERROR_SUPPORT_TICKET_MERCHANT_NOT_LINKED (HTTP 403)

merchant_account_id is not an active merchant of the calling partner.

ERROR_CREATE_SUPPORT_TICKET (HTTP 500)

The support system or an internal call failed.

List tickets

Error Code

Message

INVALID_FIELD - [STATUS | PAGE | LIMIT | ORDER_BY | DIRECTION | ID | SUBJECT | MERCHANT_ACCOUNT_ID] (HTTP 400)

A query parameter is not valid. The code names the parameter.

ERROR_LIST_SUPPORT_TICKETS (HTTP 500)

The support system or an internal call failed.

Get ticket

Error Code

Message

INVALID_FIELD - [TICKET_ID] (HTTP 400)

The ticket ID has a bad format.

ERROR_SUPPORT_TICKET_NOT_FOUND (HTTP 404)

The ticket does not exist, or it is not the caller's.

ERROR_GET_SUPPORT_TICKET (HTTP 500)

The support system or an internal call failed.

Edit ticket

Error Code

Message

MISSING_FIELDS - [SUBJECT | DESCRIPTION] (HTTP 400)

The request has nothing to change.

INVALID_FIELD - [SUBJECT | DESCRIPTION | TICKET_ID] (HTTP 400)

A value is not valid.

ERROR_SUPPORT_TICKET_CLOSED (HTTP 400)

The ticket has the status closed.

ERROR_SUPPORT_TICKET_NOT_FOUND (HTTP 404)

The ticket does not exist, or it is not the caller's.

ERROR_EDIT_SUPPORT_TICKET (HTTP 500)

The support system or an internal call failed.

Close ticket

Error Code

Message

INVALID_FIELD - [TICKET_ID] (HTTP 400)

The ticket ID has a bad format.

ERROR_SUPPORT_TICKET_NOT_FOUND (HTTP 404)

The ticket does not exist, or it is not the caller's.

ERROR_CLOSE_SUPPORT_TICKET (HTTP 500)

The support system or an internal call failed.

Add comment

Error Code

Message

MISSING_FIELDS - [TEXT] (HTTP 400)

text is missing.

INVALID_FIELD - [TEXT | CONTACT | ATTACHMENTS | TICKET_ID] (HTTP 400)

A value is not valid.

ERROR_SUPPORT_TICKET_INVALID_ATTACHMENT, ERROR_SUPPORT_TICKET_ATTACHMENT_TYPE_NOT_ALLOWED, ERROR_SUPPORT_TICKET_ATTACHMENT_TOO_LARGE (HTTP 400)

A token or file is not acceptable.

ERROR_SUPPORT_TICKET_CLOSED (HTTP 400)

The ticket has the status closed.

ERROR_SUPPORT_TICKET_NOT_FOUND (HTTP 404)

The ticket does not exist, or it is not the caller's.

ERROR_ADD_SUPPORT_TICKET_COMMENT (HTTP 500)

The support system or an internal call failed.

Download attachment

Error Code

Message

INVALID_FIELD - [TICKET_ID | FILE_ID] (HTTP 400)

An ID has a bad format.

ERROR_SUPPORT_TICKET_NOT_FOUND (HTTP 404)

The ticket does not exist, or it is not the caller's.

ERROR_SUPPORT_TICKET_ATTACHMENT_NOT_FOUND (HTTP 404)

The file is not an attachment of this ticket, or the API cannot read it.

ERROR_GET_SUPPORT_TICKET_ATTACHMENT (HTTP 500)

The support system or an internal call failed.