Authorization Header

Bad Request

Status 400 Bad Request

Authorization header not entered

{
    "errors": [
        {
            "message": "Value is required and can't be empty",
            "location": "header.authorization"
        }
    ]
}

Unauthorized

Status 401 Unauthorized

Direct API

Status 400 Bad Request

Integration

Integration reference errors:

{
"errors": [
        {
            "message": "Value is required and can't be empty",
            "location": "body.integration.reference"
        },
        {
            "message": "The input does not match against pattern '^([A-Za-z0-9-_])+$'",
            "location": "body.integration.reference"
        },
        {
            "message": "The input is less than 4 characters long",
            "location": "body.integration.reference"
        },
        {
            "message": "The input is more than 64 characters long",
            "location": "body.integration.reference"
        },
        {
            "message": "Invalid type given. String expected",
            "location": "body.integration.reference"
        }
    ]
}

Integration notification URL errors:

{
"errors": [
        {
            "message": "The input does not appear to be a valid Url",
            "location": "body.integration.notification_url"
        },
        {
            "message": "The input is more than 200 characters long",
            "location": "body.integration.notification_url"
        },
        {
            "message": "Value is required and can't be empty",
            "location": "body.integration.notification_url"
        },
        {
            "message": "Invalid type given. String expected",
            "location": "body.integration.notification_url"
        }
    ]
}

Integration language errors:

{
  "errors": [
        {
            "message": "Value is required and can't be empty",
            "location": "body.integration.language"
        },
        {
            "message": "Invalid value. Options are: en_US, es_ES, pt_BR, pt_PT, tr_TR",
            "location": "body.integration.language"
        }
    ]
}

Order

Order currency errors:

{
  "errors": [
        {
            "message": "Value is required and can't be empty",
            "location": "body.order.currency"
        },
        {
            "message": "Invalid currency for charge country BR. Options are: BRL",
            "location": "body.order.currency"
        },
        {
            "message": "Invalid currency for charge country CL. Options are: CLP",
            "location": "body.order.currency"
        },
        {
            "message": "Invalid currency for charge country CO. Options are: COP",
            "location": "body.order.currency"
        },
        {
            "message": "Invalid currency for charge country MX. Options are: MXN",
            "location": "body.order.currency"
        },
        {
            "message": "Invalid currency for charge country PE. Options are: PEN",
            "location": "body.order.currency"
        },
        {
            "message": "Invalid value. Options are: BRL, CLP, COP, MXN, PEN",
            "location": "body.order.currency"
        }
    ]
}

Order items errors:

{
  "errors": [
        {
            "message": "Value is required and can't be empty",
            "location": "body.order.items"
        },
        {
            "message": "The items count must be less or equal than 100",
            "location": "body.order.items"
        }
    ]
}

Order items quantity errors:

{
  "errors": [
        {
            "message": "The input is not strictly an integer",
            "location": "body.order.items.0.quantity"
        },
        {
            "message": "The input is not greater than or equal to 1",
            "location": "body.order.items.0.quantity"
        },
        {
            "message": "Value is required and can't be empty",
            "location": "body.order.items.0.quantity"
        }
    ]
}

Order items description errors:

{
  "errors": [
        {
            "message": "Invalid type given. String expected",
            "location": "body.order.items.0.description"
        },
        {
            "message": "Value is required and can't be empty",
            "location": "body.order.items.0.description"
        },
        {
            "message": "The input is more than 180 characters long",
            "location": "body.order.items.0.description"
        }
    ]
}

Order items unit_price errors:

{
  "errors": [
                {
            "message": "The input is not strictly a float",
            "location": "body.order.items.0.unit_price"
        },
        {
            "message": "The input is not greater than or equal to 0.01",
            "location": "body.order.items.0.unit_price"
        },
        {
            "message": "Value is required and can't be empty",
            "location": "body.order.items.0.unit_price"
        }
    ]
}

Charge

Charge country errors:

{
"errors": [
        {
            "message": "Invalid value. Options are: BR, CL, CO, MX, PE",
            "location": "body.charge.type"
        },
        {
            "message": "Value is required and can't be empty",
            "location": "body.charge.type"
        }
    ]
}

Charge type errors:

{ 
"errors": [
        {
            "message": "Invalid value. Options are: CREDIT_CARD",
            "location": "body.charge.type"
        },
        {
            "message": "Value is required and can't be empty",
            "location": "body.charge.type"
        }
    ]
}

Charge credit_card errors:

{
"errors": [
        {
            "message": "Value is required and can't be empty",
            "location": "body.charge.credit_card"
        },
        {
            "message": "Invalid value. Options are: raw or token",
            "location": "body.charge.credit_card"
        }
    ]
}

Charge credit_card raw errors:

{
"errors": [
        {
            "message": "The credit card is already expired",
            "location": "body.charge.credit_card.raw"
        },
        {
            "message": "Value is required and can't be empty",
            "location": "body.charge.credit_card.raw"
        }
    ]
}

Charge credit_card raw number errors:

{
"errors": [
        {
            "message": "The input is more than 19 characters long",
            "location": "body.charge.credit_card.raw.number"
        },
        {
            "message": "The input is less than 12 characters long",
            "location": "body.charge.credit_card.raw.number"
        },
        {
            "message": "The input must contain only digits",
            "location": "body.charge.credit_card.raw.number"
        },
        {
            "message": "Value is required and can't be empty",
            "location": "body.charge.credit_card.raw.number"
        },
        {
            "message": "Invalid type given. String expected",
            "location": "body.charge.credit_card.raw.number"
        }
    ]
}

Charge credit_card raw cvc errors:

{
"errors": [
        {
            "message": "The input is more than 4 characters long",
            "location": "body.charge.credit_card.raw.cvc"
        },
        {
            "message": "The input is less than 3 characters long",
            "location": "body.charge.credit_card.raw.cvc"
        },
        {
            "message": "The input must contain only digits",
            "location": "body.charge.credit_card.raw.cvc"
        },
        {
            "message": "Value is required and can't be empty",
            "location": "body.charge.credit_card.raw.cvc"
        },
        {
            "message": "Invalid type given. String expected",
            "location": "body.charge.credit_card.raw.cvc"
        }
    ]
}

Charge credit_card raw expiration_month errors:

{
"errors": [
        {
            "message": "Invalid value. Options are: 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12",
            "location": "body.charge.credit_card.raw.expiration_month"
        },
        {
            "message": "Value is required and can't be empty",
            "location": "body.charge.credit_card.raw.expiration_month"
        }
    ]
}

Charge credit_card raw expiration_year errors:

{
"errors": [
        {
            "message": "The input does not appear to be a valid year",
            "location": "body.charge.credit_card.raw.expiration_year"
        },
        {
            "message": "Value is required and can't be empty",
            "location": "body.charge.credit_card.raw.expiration_year"
        },
        {
            "message": "Invalid type given. String expected",
            "location": "body.charge.credit_card.raw.expiration_year"
        }
    ]
}

Charge credit_card raw holder_name errors:

{
"errors": [
        {
            "message": "Invalid type given. String expected",
            "location": "body.charge.credit_card.raw.holder_name"
        },
        {
            "message": "The input contains leading or trailing blanks",
            "location": "body.charge.credit_card.raw.holder_name"
        },
        {
            "message": "The input is less than 2 characters long",
            "location": "body.charge.credit_card.raw.holder_name"
        },
        {
            "message": "The input is more than 26 characters long",
            "location": "body.charge.credit_card.raw.holder_name"
        },
        {
            "message": "The input contains more than one space between words",
            "location": "body.charge.credit_card.raw.holder_name"
        },
        {
            "message": "The input contains invalid characters",
            "location": "body.charge.credit_card.raw.holder_name"
        },
        {
            "message": "Value is required and can't be empty",
            "location": "body.charge.credit_card.raw.holder_name"
        }
    ]
}

Charge credit_card token errors:

{
"errors": [
        {
            "message": "Value is required and can't be empty",
            "location": "body.charge.credit_card.token"
        },
        {
            "message": "Invalid value given",
            "location": "body.charge.credit_card.token"
        },
        {
            "message": "Invalid type given. String expected",
            "location": "body.charge.credit_card.token"
        }
    ]
}

Payer

Payer email errors:

{
"errors": [
        {
            "message": "Invalid type given. String expected",
            "location": "body.payer.email"
        },
        {
            "message": "The input is not a valid email address. Use the basic format [email protected]",
            "location": "body.payer.email"
        },
        {
            "message": "The input is more than 60 characters long",
            "location": "body.payer.email"
        },
        {
            "message": "Value is required and can't be empty",
            "location": "body.payer.email"
        }
    ]
}

Payer ip errors:

{
"errors": [
        {
            "message": "Invalid type given. String expected",
            "location": "body.payer.ip"
        },
        {
            "message": "The input is not a valid ip address",
            "location": "body.payer.ip"
        },
        {
            "message": "The input is more than 39 characters long",
            "location": "body.payer.ip"
        },
        {
            "message": "Value is required and can't be empty",
            "location": "body.payer.ip"
        }
    ]
}

Payer person errors:

Payer person name errors:

{
"errors": [
        {
            "message": "Value is required and can't be empty",
            "location": "body.payer.person.name"
        },
        {
            "message": "Invalid type given. String expected",
            "location": "body.payer.person.name"
        },
        {
            "message": "The input is less than 4 characters long",
            "location": "body.payer.person.name"
        },
        {
            "message": "The input is more than 50 characters long",
            "location": "body.payer.person.name"
        },
        {
            "message": "The input contains leading or trailing blanks",
            "location": "body.payer.person.name"
        },
        {
            "message": "The input contains invalid characters",
            "location": "body.payer.person.name"
        },
        {
            "message": "The surnames words must be between 1 and 40 characters long",
            "location": "body.payer.person.name"
        },
        {
            "message": "The input must have more than one word",
            "location": "body.payer.person.name"
        },
        {
            "message": "The first name must be greater than or equal to 2 characters long",
            "location": "body.payer.person.name"
        },
        {
            "message": "The input contains more than one space between words",
            "location": "body.payer.person.name"
        },
        {
            "message": "Value is required and can't be empty",
            "location": "body.payer.person.name"
        }
    ]
}

Payer person birthdate errors:

{
"errors": [
        {
            "message": "Invalid type given. String expected",
            "location": "body.payer.person.birth_date"
        },
        {
            "message": "The input does not appear to be a valid date",
            "location": "body.payer.person.birth_date"
        },
        {
            "message": "The input does not fit the date format 'Y-m-d'",
            "location": "body.payer.person.birth_date"
        },
        {
            "message": "Value is required and can't be empty",
            "location": "body.payer.person.birth_date"
        }
    ]
}

Payer person document errors:

Payer person document type errors:

{
"errors": [
        {
            "message": "Value is required and can't be empty",
            "location": "body.payer.person.document.type"
        },
        {
            "message": "Invalid value. Options are: CC, CE, CPF, CURP, DNI, NIT, RFC, RUT, TI, RUC",
            "location": "body.payer.person.document.type"
        },
        {
            "message": "Invalid document for charge country CO. Options are: CC, CE, TI, NIT",
            "location": "body.payer.person.document.type"
        },
        {
            "message": "Invalid document for charge country MX. Options are: CURP, RFC",
            "location": "body.payer.person.document.type"
        },
        {
            "message": "Invalid document for charge country CL. Options are: RUT",
            "location": "body.payer.person.document.type"
        },
        {
            "message": "Invalid document for charge country PE. Options are: DNI, CE, RUC",
            "location": "body.payer.person.document.type"
        },
        {
            "message": "Invalid document for charge country BR. Options are: CPF",
            "location": "body.payer.person.document.type"
        }
    ]
}

Payer person document number errors:

{
"errors": [
        {
            "message": "Invalid type given. String expected",
            "location": "body.payer.person.document.number"
        },
        {
            "message": "Value is required and can't be empty",
            "location": "body.payer.person.document.number"
        },
        {
            "message": "The input is invalid for document type CPF",
            "location": "body.payer.person.document.number"
        },
        {
            "message": "The input is invalid for document type CC",
            "location": "body.payer.person.document.number"
        },
        {
            "message": "The input is invalid for document type CE",
            "location": "body.payer.person.document.number"
        },
        {
            "message": "The input is invalid for document type TI",
            "location": "body.payer.person.document.number"
        },
        {
            "message": "The input is invalid for document type NIT",
            "location": "body.payer.person.document.number"
        },
        {
            "message": "The input is invalid for document type CURP",
            "location": "body.payer.person.document.number"
        },
        {
            "message": "The input is invalid for document type RFC",
            "location": "body.payer.person.document.number"
        },
        {
            "message": "The input is invalid for document type RUT",
            "location": "body.payer.person.document.number"
        },
        {
            "message": "The input is invalid for document type DNI",
            "location": "body.payer.person.document.number"
        },
        {
            "message": "The input is invalid for document type RUC",
            "location": "body.payer.person.document.number"
        }
    ]
}

Payer person phone errors:

Payer person phone country_code errors:

{
"errors": [
        {
            "message": "The input must contain only digits",
            "location": "body.payer.person.phone.country_code"
        },
        {
            "message": "The input is more than 3 characters long",
            "location": "body.payer.person.phone.country_code"
        },
             {
            "message": "Invalid type given. String expected",
            "location": "body.payer.person.phone.country_code"
        },
        {
            "message": "Value is required and can't be empty",
            "location": "body.payer.person.phone.country_code"
        }
    ]
}

Payer person phone number errors:

{
"errors": [
        {
            "message": "The input must contain only digits",
            "location": "body.payer.person.phone.number"
        },
        {
            "message": "The input is more than 11 characters long",
            "location": "body.payer.person.phone.number"
        },
        {
            "message": "Invalid type given. String expected",
            "location": "body.payer.person.phone.number"
        },
        {
            "message": "Value is required and can't be empty",
            "location": "body.payer.person.phone.number"
        }
    ]
}

Domain Errors

Status 422 Unprocessable Entity

{
    "error": "payer_on_deny_list"
},
{
    "error": "payer_not_found"
},
{
    "error": "payer_irregular_register"
},
{
    "error": "payer_underaged"
},
{
     "error": "payer_name_does_not_match"
},
{
     "error": "payer_deceased"
},
{
     "error": "payer_legal_data_unavailable"
},
{
     "error": "payer_legal_constraints"
},
{
     "error": "payer_national_id_cancelled"
},
{
     "error": "payer_national_id_inactive"
},
{
     "error": "payer_buy_limit_exceed"
},
{
     "error": "payer_information_invalid"
},
{
     "error": "charge_payment_method_not_enabled"
},
{
     "error": "integration_reference_already_exists"
}