When Pay-i encounters an error, it will return a code and a message.
The code represents the type of error, and can be used in your service for control flow to retry and navigate around issues. A change to a code is considered a breaking change.
The message provides a human-readable, friendly string intended to assist with diagnosing issues. The message values will change over time as we improve our error reporting to make it easier to debug.
The below section is organized by groups of APIs. Each section describes the error codes and sample messages you may encounter when working with that group of APIs. Messages are subject to change at any time.
All APIs
Code
Message
invalid_api_key
Your api key is invalid, missing, or expired.
All apis which accept tags as input
Code
Message
invalid_tags
{0} contains an invalid tag name '{1}'. Alphanumeric, underscore (_) and dash (-) only
All Proxy APIs (excluding Ingest)
Code
Message
invalid_provider_host
The provided host URI '{0}' is invalid
invalid_provider_uri
The provided URI '{0}' is invalid
invalid_provider_ssl_certificate
The provided host URI '{0}' SSL certificate invalid
unexpected_error
The system has encountered an unexpected error
All Proxy and Ingest APIs
Code
Message
required_field_missing
Required request field '{0}' is missing
invalid_tags
{0} contains an invalid tag name '{1}'. Alphanumeric, underscore (_) and dash (-) only
experience_type_not_found
Experience type name '{0}' not found
experience_instance_not_found
Experience id '{0}' not found
invalid_user_id
User Id '{0}' is not valid
invalid_json
Body JSON is invalid
category_not_found
Category '{0}' not found
category_resource_not_found
Category '{0}' and resource '{1}' not found
When providing a Limit ID to Proxy/Ingest APIs
Code
Message
invalid_limit_id
Invalid limit id '{0}'
invalid_limit_ids
Some or all of passed limit-ids either do not exist or they are not related to the Application
limit_reached
Insufficient limit for the requested operation
All Ingest APIs (excluding Proxy)
Code
Message
invalid_ingest_event_timestamp
Ingest event_timestamp {0} cannot be greater than 5 minutes into the future {1}
blocking_limit_not_allowed
Block limits cannot be used for ingest requests
category_resource_not_found
Category '{0}' and resource '{1}' and event timestamp '{2}' not found
Limit APIs
Code
Message
limit_not_found
Limit Id '{0}' not found
create_limit_validation_failed
A error message for the specific validation that failed
update_limit_validation_failed
A error message for the specific validation that failed
limit_name_already_exist
Limit name '{0}' already exists
invalid_max_limit_update
New Limit max value cannot less than the current spent of '{0}'
Experience APIs
Code
Message
experience_type_id_invalid
Experience type id '{0}' is invalid
experience_type_not_found
Experience type id '{0}' not found
experience_id_invalid
Experience id '{0}' is invalid
experience_instance_not_found
Experience id '{0}' not found
invalid_experience_name
Experience name '{0}' must be unique, not empty, max 64 characters
invalid_experience_description
Experience description '{0}' must be supplied, max 256 characters
