These docs are for v2.2. Click to read the latest docs for v4.1.

Tabelas de erros

Você receberá um HTTP Status 400, 401, 403, 404 , 406ou 415 como resposta quando não conseguirmos prosseguir com a operação devido há um parâmetro mal formatado ou valor inesperado. Nesse caso você deve verificar o conteúdo enviado e corrigir o erro para realizar uma nova requisição, para te ajudar no corpo da resposta vamos informar qual o erro encontrado e o tipo de erro.

O payload de erro segue o seguinte padrão:

{
    "error_messages": [
        {
            "error": "invalid_value",
            "description": "Field has an invalid value. Please check the documentation.",
            "parameter_name": "customer.tax_id"
        }
    ]
}

Lista de erros existentes:

CenárioErrorDescriptionPamameter_name
O header Authorization não adere às especificações da documentação.invalid_authorization_headerInvalid credential. Review AUTHORIZATION header
O vendedor não foi homologado pelo PagBank. Contate-nos para mais informações.allowlist_access_requiredAllowlist access required. Contact PagBank.
Acesso negado. Contate-nos para mais informações.access_deniedAccess denied.
Existem erros de sintaxe no corpo da requisição. Os dados estão em um formato inválido.invalid_request_bodyThere are some syntax errors in the request payload. Please check the documentation.
O campo referenciado pelo parameter_name não pode ser vazio.field_cannot_be_emptyField cannot be empty.Parameter_name será referenciado dinamicamente no retorno da chamada pelo campo do Payload: "parameter_name"
O campo referenciado pelo parameter_name está com um tamanho inválido.invalid_lengthField with invalid length. Please check the documentation.Parameter_name será referenciado dinamicamente no retorno da chamada pelo campo do Payload: "parameter_name"
A lista referenciada pelo parameter_name contém pelo menos um elemento com tamanho inválido.invalid_list_element_lengthList has at least one element with invalid length. Please check the documentationParameter_name será referenciado dinamicamente no retorno da chamada pelo campo do Payload: "parameter_name"
O valor informado no campo referenciado pelo parameter_name não é aceito. O campo é do tipo enum e só aceita determinados valores.invalid_enumField with invalid value. Please check the documentation.Parameter_name será referenciado dinamicamente no retorno da chamada pelo campo do Payload: "parameter_name"
O campo referenciado pelo parameter_name contém um valor que não adere às especificações da documentação.invalid_formatField has an invalid format. Please check the documentation.Parameter_name será referenciado dinamicamente no retorno da chamada pelo campo do Payload: "parameter_name"
O campo referenciado pelo parameter_name contém um valor inválido.invalid_valueField has an invalid value. Please check the documentation.Parameter_name será referenciado dinamicamente no retorno da chamada pelo campo do Payload: "parameter_name"
A lista referenciada pelo parameter_name contém pelo menos um elemento que não adere às especificações da documentação.invalid_list_element_valueList has at least one element with invalid value. Please check the documentation.Parameter_name será referenciado dinamicamente no retorno da chamada pelo campo do Payload: "parameter_name"
O campo shipping possui uma configuração que não adere às especificações da documentação.invalid_shipping_configField shipping has an invalid configuration. Please check the documentation.shipping
O ID de checkout informado no query param é inexistente.checkout_not_foundThe requested checkout was not found.
O checkout está expirado.checkout_expiredThe requested checkout has expired.
O valor informado de desconto é maior que o valor da compra. O valor da compra é dado por: soma do valor dos itens + valor adicional.invalid_discount_valueInformed discount value is invalid. Please check the documentation.discountAmount
O valor do carrinho ultrapassa o valor máximo permitido. O valor do carrinho é dado por: soma do valor dos itens + valor do frete + valor adicional - desconto.invalid_cart_total_valueTotal cart value exceeds the maximum value allowed. Please check the documentation.
O shipping.service_type informado é inválido para frete calculado. O valor deve ser PAC, SEDEX ou nulo.invalid_calculate_shipping_configIt is not possible to calculate the shipping cost with the chosen service type. Please check the documentation.Parameter_name será referenciado dinamicamente no retorno da chamada pelo campo do Payload: "parameter_name"
Existe mais de uma configuração para a mesma bandeira de cartão.inconsistent_brand_configurationsThere are repeated card brands in the paymentMethodConfigs field.paymentMethodsConfigs
O meio de pagamento informado não tem suporte a configurações customizadas.invalid_payment_methodThe payment method is not valid to be configured.payment_methods_configs[].type
O meio de pagamento informado não tem bandeiras.field_brands_is_not_compatible_with_payment_methodThe field brands cannot be in request with the given payment method.payment_methods[].type
A configuração de meio de pagamento referenciada pelo parameter_name não adere às especificações da documentação.invalid_config_optionThe option field or value field are invalid. Please check the documentation.payment_methods_configs[].config_options[]
A configuração de meio de pagamento referenciada pelo parameter_name está repetida.repeated_optionsThere are payment method configuration options repeated.payment_methods_configs[].config_options
Existem configurações de meio de pagamento conflitantes.inconsistent_checkout_payment_method_configsThere are inconsistent payment method configurations.paymentMethodConfigs
O valor do frete deve ser informado caso o shipping.type contenha o valor FIXED.invalid_fixed_shipping_configurationField has an invalid configuration for fixed shipping. Please check documentation.shipping.amount
O endereço deve estar completo caso shipping.address_modifiable contenha o valor false.invalid_unmodifiable_addressAddress must be complete when it's unmodifiable.shipping.address