HTTP API
此内容尚不支持你的语言。
Receiving Autopilot Errors
Section titled “Receiving Autopilot Errors”When an API response fails for any reason, a 4xx or 5xx error will always be provided with an object in the error schema format. The HTTP response code is determined based on the associated HTTP status code for the Autopilot error code in the base object. Any codes within the Error Detail schema will have no effect on the HTTP status code.
Optionally, when applicable, Autopilot will also contain an errors key inside of the error schema with information about specific field validation, and as much other information that Autopilot is able to provide regarding the reason for the request failure. If an error is being forwarded from a 3rd party (such as from a payment or payout provider). Autopilot may not always be able to provide precise information about the reason of the failure.
Error Schema
Section titled “Error Schema”| Field | Type | Description |
|---|---|---|
| code | string | The Autopilot error code. |
| errors | error detail[] | Sub-errors providing more error contextual information. |
| message | string | Error explanation |
Error Detail Schema
Section titled “Error Detail Schema”| Field | Type | Description |
|---|---|---|
| code | string | The Autopilot error code. |
| location? | string | The location of the error in the request input, provided when performing during request validation |
| metadata? | object | The request validation parameters |
| message | string | Error explanation |
Status Code Information
Section titled “Status Code Information”| CODE | MESSAGE | HTTP STATUS CODE |
|---|---|---|
| Unknown | An unknown error has occured. | 500 |
| EntityNotFound | Entity not found. | 404 |
| Unauthenticated | Unauthenticated. | 401 |
| InsufficientPermissions | Insufficient permissions. | 403 |
| InvalidIdempotencyKey | Invalid idempotency key. Length must be between 12 and 36 characters | 400 |
| IdempotencyKeyNotAllowed | Idempotency is not supported for this HTTP method. | 400 |
| InvalidBody | Invalid request body | 400 |
| Required | This field is required. | 400 |
| InvalidValue | Invalid value provided. | 400 |
| InvalidDate | Invalid date format. | 400 |
| InvalidDateTime | Invalid datetime format. | 400 |
| InvalidTime | Invalid time format. | 400 |
| InvalidEmail | Invalid email address. | 400 |
| InvalidHostname | Invalid hostname. | 400 |
| InvalidIPv4 | Invalid IPv4 address. | 400 |
| InvalidIPv6 | Invalid IPv6 address. | 400 |
| InvalidUUID | Invalid UUID. | 400 |
| InvalidURI | Invalid URI. | 400 |
| InvalidPublicKey | Invalid public key. | 400 |
| MissingLowercase | Expected at least one lowercase letter. | 400 |
| MissingUppercase | Expected at least one uppercase letter. | 400 |
| MissingNumber | Expected at least one number. | 400 |
| MissingSpecial | Expected at least one special character. | 400 |
| TooShort | Length is too short. | 400 |
| TooLong | Length is too long. | 400 |
| DuplicateItems | Duplicate items are not allowed. | 400 |
| TooSmall | Value is too small. | 400 |
| TooLarge | Value is too large. | 400 |
| InvalidImageFormat | Invalid image format. | 400 |
| InvalidCursor | Invalid cursor format | 400 |
| InvalidTurnstileToken | Invalid Turnstile token. | 401 |
| FailedToVerifyTurnstileToken | Failed to verify Turnstile token. | 401 |
| InvalidCurrency | Invalid currency code. | 400 |
| InvalidCountry | Invalid country code. | 400 |
| InvalidFinancialAmount | Invalid financial amount. | 400 |
| ProviderNotFound | Provider not found. | 404 |
| ProviderUnavailable | Provider is not available at this time. | 503 |
| UnsupportedProvider | Unsupported provider for specified method. | 400 |
| UnsupportedProviderCountryCurrency | Unsupported provider for specified country and currency. | 422 |
| ProviderNotConfigured | Provider not configured by entity. | 422 |
| ProviderFailed | Provider could not process transaction. | 503 |
| InvalidPayoutMethod | Invalid payout method type provided. | 422 |
| TransactionNotFound | Transaction not found. | 404 |
| ClientReferenceIDUnavailable | The provided client reference ID is already used. | 409 |
| ProcessorError | Unknown processor error. | 503 |
| InvalidTransactionAmount | Invalid request amount provided | 400 |
| InvalidBeneficiary | Invalid beneficiary details. | 422 |
| InvalidSender | Invalid sender details. | 422 |
| AccountLocked | The account is temporarily locked. | 429 |
| EmailNotVerified | Email verification is required. | 401 |
| InvalidCredentials | Invalid login credentials. | 401 |
| InvalidRefreshToken | Invalid refresh token. | 401 |
| APIKeyNotFound | API key not found. | 404 |
| APIKeyExpired | API key has expired. | 401 |
| APIKeyMissingEntity | API key has no associated entity. | 401 |
| InvalidAPIKeyMode | Invalid API key mode | 422 |
| InvalidName | Invalid API key name | 422 |
| InvalidAPIKeyToken | Invalid API key token | 422 |
| ConnectionNotFound | Connection not found. | 404 |
| InvalidConnectionCredentials | Invalid connection credentials. | 422 |
| InvalidConnectionWebhookSlug | The specified webhook slug is not available. | 422 |
| WebhookNotFound | Webhook not found. | 404 |
| InvalidWebhookEvent | Invalid webhook event. | 422 |
| EmailExists | Email already exists. | 422 |
| InvalidOrExpiredToken | The verification token is invalid or expired. | 401 |
| UserNotFound | User not found. | 404 |
| InvalidTwoFactorCode | Invalid two-factor code. | 401 |
| TwoFactorNotEnabled | Two-factor authentication is not enabled. | 400 |
| TwoFactorAlreadyEnabled | Two-factor authentication is already enabled. | 400 |
| TwoFactorPending | Two-factor authentication verification pending. | 400 |
| BackupCodeValidation | Invalid or used backup code. | 401 |
| TwoFactorLocked | Two-factor authentication is locked. | 429 |