Handle endpoint errors

MatchMove uses standard HTTP response codes to indicate the status of a request made to the MatchMove platform. API consumers must ensure that HTTP status and status messages are handled accordingly with straight-through processing.

Anatomy of an error message

The error message consists of the HTTP response code and the response body.

The response body is comprised of:

• an HTTP status code
• an HTTP status message
• a response body

The response body elaborates more information on the error, which the partner may need to address or handle at run time.

Refer to the status codes table on the right.

About error messages

The MatchMove platform returns various types of errors to allow you to distinctly understand the failure that happened and how to manage it. These scenarios can cover payment failures, invalid calling of the API, using the API to perform functionality that is not allowed or temporarily prohibited, or, in extreme scenarios, platform issues.

Every API specification specifies the HTTP status codes and error codes that can be returned for that API call.

Parse error data

As an API consumer, you are encouraged to parse and manage the error object appropriately. Depending on the type of error, your handling of it will be different and broadly divided into one of the categories listed below.

The MatchMove error objects are made up of a combination of the properties listed in the table below.

Error handling and management

User communication

As part of the integration, you are encouraged to investigate the error and respond by displaying a human-readable message to your end user. Scenarios could include a user attempting to access functionality that is not permitted or not allowed.

Validate integration

In addition, ensure that validation_errors are properly handled and managed. Any entity or object related to payments will have the MatchMove platform as the source of truth. You should wait until the entity has been successfully created in the Matchmove system before committing its attributes. A validation_error indicates that there is a problem with the supported characters of validations in terms of value for a specific field, and you should investigate and correct the integration.

Payment & transaction failures

Some failures may be the result of payment failures, which can be attributed to any party in the value chain. The error code allows you to narrow down the reason and appropriately handle customer service.