Códigos de Status HTTP
Em poucas palavras, existem apenas 3 resultados na interação entre seu aplicativo e nossa API:
* Tudo funcionou
* O aplicativo fez algo errado
* A API fez algo errado
A API WC Pagamentos tenta retornar códigos de status de resposta HTTP apropriados para cada solicitação.
Em geral, os códigos no intervalo 2xx indicam sucesso, os códigos no intervalo 4xx indicam um erro resultante das informações fornecidas (por exemplo, um parâmetro necessário faltou, uma transação falhou, etc.) e os códigos no intervalo 5xx indicam um erro com os servidores da WC Pagamentos.
A tabela a seguir contém os valores mais comuns para os códigos de status HTTP retornados pela API:
| HTTP STATUS CODE | Texto | Descrição |
|---|---|---|
| 200 | OK | Tudo funcionou conforme o esperado. |
| 201 | Created | A requisição foi bem sucedida e um novo recurso foi criado. |
| 304 | Not Modified | Não havia dados novos para retornar. |
| 400 | Bad Request | A requisição foi invalida ou não atingiu o servidor. Muitas vezes, falta um parâmetro obrigatório. |
| 401 | Unauthorized | As credenciais de autenticação estavam faltando ou foram incorretas. |
| 402 | Request Failed | Os parâmetros foram válidos mas a requisição falhou. |
| 403 | Forbidden | A requisição foi ok, mas foi recusado ou o acesso não foi permitido. Uma mensagem de erro que acompanha a mensagem explica o porquê. |
| 404 | Not Found | A URI solicitada é inválida ou o recurso solicitado, como por exemplo, um vendedor não existe ou foi excluído. |
| 500 | Internal Server Error | A URI solicitada é inválida ou o recurso solicitado, como por exemplo, um vendedor não existe ou foi excluído. |
| 502 | Bad Gateway | A WC Pagamentos caiu ou está sendo atualizada. |
Mensagens de erro
Quando uma requisição de API falha, a WC Pagamentos retornará um código de resposta HTTP 4xx ou 5xx que identifica genericamente a falha, bem como uma resposta JSON que fornece informações mais específicas sobre o erro (ou os erros) que causou a falha.
A resposta conterá:
- O status e o status_code.
- O tipo e a categoria que você pode usar para programar as respostas aos erros.
- Uma mensagem legível para humanos que explica por que o erro ocorreu.
- Os valores possíveis para o parâmetro de tipo estão listados abaixo:
| Status code | Tipo | Categoria | Descrição | Cód. erro bandeira |
|---|---|---|---|---|
| 500 Ocorreu | processing_error | server_api_error | um erro de processamento na WC Pagamentos. Se você receber esta mensagem, entre em contato com [email protected] | |
| 409 | invalid_request_error | duplicate_taxpayer_id | Customer with this taxpayer_id already exists. | |
| 408 | invalid_request_error | service_request_timeout | Credit card process is temporarily unavailable at the specified location. | |
| 404 | invalid_request_error | endpoint_not_found | The requested URL was not found on the server | |
| 401 | invalid_request_error | authentication_failed | The supplied user credentials failed validation for the requested service. | |
| 401 | invalid_request_error | expired_security_key | The API Key provided has expired or has been deleted. | |
| 401 | invalid_request_error | invalid_key_for_api_call | This API call cannot be made with a publishable API key. | |
| 400 | invalid_request_error | transaction_amount_error | The minimum amount is $0.50 (or equivalent in country currency). The amount must be a positive integer in cents representing how much to charge, e.g 1260 for $12.60. | |
| 400 | invalid_request_error | transfer_amount_error | The minimum transfer amount is $1.00 (or equivalent in country currency). The amount must be a positive integer in cents representing how much to charge, e.g 1260 for $12.60. | |
| 400 | invalid_request_error | missing_required_param | Missing required parameter(s). Please verify request parameters. | |
| 400 | invalid_request_error | unsupported_payment_type | Invalid request: unsupported payment type. | |
| 400 | invalid_request_error | invalid_payment_information | Invalid payment information. Please verify request parameters. | |
| 400 | invalid_parameter | Invalid parameter(s). | Your parameter value is incorrect. Please verify request parameters. | |
| 402 | file_upload | file_size_too_large | ||
| 402 | invalid_request_error | insufficient_escrow_funds_error | Requested transfer exceeds remaining settled funds in escrow. | |
| 402 | invalid_request_error | capture_transaction_error | The capture request failed. Transaction could not be captured. | |
| 402 | invalid_request_error | no_action_taken | No action taken. Unable to back out prior transaction | |
| 402 | invalid_request_error | seller_authorization_refused | Seller has not been authorized to charge credit cards. Complete activation to start processing payments. | |
| 402 | invalid_request_error | void_transaction_error | The void request failed. Transaction could not be voided. | |
| 402 | card_error | invalid_expiry_month | Invalid expiry month value. Please verify request parameters. | |
| 402 | card_error | invalid_expiry_year | Invalid expiry year value. Please verify request parameters. | |
| 402 | card_error | card_customer_not_associated | Transaction denied. No active card. | |
| 402 | card_error | insufficient_funds_error | Requested credit exceeds remaining settled funds. | 51 |
| 402 | card_error | expired_card_error | The credit card has expired. | 33 |
| 402 | card_error | invalid_card_number | The card number is not a valid credit card number. | 15 |
| 402 | card_error | invalid_pin_code | Transaction denied. Invalid PIN code. | 55 |
| 402 | card_error | authorization_refused | Transação ilegal | 58 |