Overview
Metaprise uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Metaprise’s servers (these are rare).
Some 4xx errors that could be handled programmatically (e.g., a card is declined) include an error code that briefly explains the error reported.
Attributes
type enum
The type of error returned. One ofapi_error
,card_error
,idempotency_error
, orinvalid_request_error
Possible enum values api_error
card_error
idempotency_error
invalid_request_error
code nullable string
For some errors that could be handled programmatically, a short string indicating the error code reported.
decline_code nullable string
For card errors resulting from a card issuer decline, a short string indicating the card issuer’s reason for the decline if they provide one.
message nullable string
A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
param nullable string
The PaymentIntent object for errors returned on a request involving a PaymentIntent.
More
charge nullable string
payment_method_type nullable string
doc_url nullable string
request_log_url nullable string
setup_intent nullable object
source nullable object
payment_method nullable object
HTTP Status Code Summary
Code | Status | Description |
---|---|---|
200 | OK | Everything worked as expected. |
400 | Bad Request | The request was unacceptable, often due to missing a required parameter. |
401 | Unauthorized | No valid API key provided. |
402 | Request Failed | The parameters were valid but the request failed. |
403 | Forbidden | The API key doesn’t have permissions to perform the request. |
404 | Not Found | The requested resource doesn’t exist. |
409 | Conflict | The request conflicts with another request (perhaps due to using the same idempotent key). |
429 | Too Many Requests | Too many requests hit the API too quickly. We recommend an exponential backoff of your requests. |
500, 502, 503, 504 | Server Errors | Something went wrong on Metaprise’s end. (These are rare.) |