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

Checkout 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 project errors:

{
  "errors": [
        {
            "message": "The input is not strictly an integer",
            "location": "body.integration.project"
        },
        {
            "message": "The input is not greater than or equal to 1",
            "location": "body.integration.project"
        }
    ]
}

Order

Order currency errors:

{
  "errors": [
        {
            "message": "Value is required and can't be empty",
            "location": "body.order.currency"
        },
        {
            "message": "Invalid value. Options are: ARS, BOB, BRL, CLP, COP, CRC, EUR, GTQ, MXN, NIO, PEN, PYG, TRY, USD, UYU",
            "location": "body.order.currency"
        }
    ]
}

Order items errors:

{
  "errors": [
        {
            "message": "Value is required and can't be empty",
            "location": "body.order.items.0"
        },
        {
            "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"
        }
    ]
}

Checkout

Checkout language errors:

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

Checkout redirect_urls success errors:

{
  "errors": [
        {
            "message": "The input does not appear to be a valid Url",
            "location": "body.checkout.redirect_urls.success"
        },
        {
            "message": "Invalid type given. String expected",
            "location": "body.checkout.redirect_urls.success"
        },
        {
            "message": "Value is required and can't be empty",
            "location": "body.checkout.redirect_urls.success"
        }
    ]
}

Charge

Charge country errors:

{
"errors": [
        {
            "message": "Value is required and can't be empty",
            "location": "body.charge.country"
        },
        {
            "message": "Invalid value. Options are: AR, BO, BR, CL, CO, CR, EC, SV, GT, MX, NI, PA, PY, PE, PT, PR, ES, TR, UY, US",
            "location": "body.charge.country"
        }
    ]
}

Charge type errors:

{ 
"errors": [
        {
            "message": "Invalid value. Options are: CREDIT_CARD, DEBIT_CARD, E_WALLET, EFT, OBT, POSTPAY, PREPAY",
            "location": "body.charge.type"
        },
        {
            "message": "Only charge.type or one specific payment method must be filled",
            "location": "body.charge.type"
        }
    ]
}

Charge credit_card errors:

{
"errors": [
         {
            "message": "Invalid value. Options are: AMEX, ARGENCARD, CABAL, CENCOSUD, CMR, DINERS, EASY, ELO, HIPERCARD, JCB, JUMBO, LIDER, MAGNA, MASTERCARD, NATIVA, OCA, PARIS, RIPLEY, TARJETA_SHOPPING, TROYCARD, UNIONPAY, VISA",
            "location": "body.charge.credit_card"
        }
    ]
}

Charge debit_card errors:

{
"errors": [
        {
            "message": "Invalid value. Options are: MAESTRO, REDCOMPRA, VISA_ELECTRON, WEBPAY",
            "location": "body.charge.debit_card"
        }
    ]
}

Charge e_wallet errors:

{
"errors": [
        {
            "message": "Invalid value. Options are: GPAY, PAGSEGURO, PAYPAL, PAYVALIDA",
            "location": "body.charge.e_wallet"
        }
    ]
}

Charge eft errors:

{ 
"errors": [
        {
            "message": "Invalid value. Options are: BANBIF, BANCO_DE_OCCIDENTE, BANCO_DO_BRASIL, BANCOLOMBIA, BANRISUL, BBVA, BCP, INTERBANK, ITAU, KHIPU, PIX, SANTANDER, SCOTIABANK",
            "location": "body.charge.eft"
        }
    ]
}

Charge obt errors:

{
"errors": [
        {
            "message": "Invalid value. Options are: AKBANK, BANAMEX, BANBIF, BANCENTRO_LAFISE, BANCO_DE_BOGOTA, BANCO_DO_BRASIL, BANCO_ESTADO, BANCO_NACIONAL_CR, BANCOLOMBIA, BANCOMER, BBVA, BCI, BCP, BRADESCO, CAJA_CUSCO, CAJA_ICA, CAJA_PIURA, CAJA_TACNA, CAJA_TRUJILLO, CATHAY, CITI, DAVIVIENDA, DENIZ, ECONOMI, GARANTI, INTERBANK, ISBANK, ITAU, KASNET, KUVET, MACRO, MUCAP, MUTUAL_ALAJUEDA, PSE, PTT, SAFETYPAY, SANTANDER, SCOTIABANK, SEKER, SERVIPAG, SPEI, VAKIFAR, WESTERN, YAPI_KREDI, ZIRAAT",
            "location": "body.charge.obt"
        }
    ]
}

Charge postpay errors:

{   
 "errors": [
        {
            "message": "Invalid value. Options are: ABITAB, BANCENTRO_LAFISE, BANCO_NACIONAL_CR, BANORTE, BOLETO_FLASH, BOLETO, CASH, CATHAY, EFECTY, GANA, LAFISE, MUCAP, MULTIBANCO, MULTICAJA, MUTUAL_ALAJUEDA, OXXO, PAGO_EFECTIVO, PAGO_FACIL, PAYSHOP, RAPIPAGO, REDPAGOS, TELEDOLAR",
            "location": "body.charge.postpay"
        }
    ]
}

Charge prepay errors:

{
 "errors": [
        {
            "message": "Invalid value. Options are: TODITO",
            "location": "body.charge.prepay"
        }
    ]
}

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"
        }
    ]
}

Payer person name errors:

{
"errors": [
        {
            "message": "If value is provided can't be empty",
            "location": "body.payer.person.name"
        },
        {
            "message": "Invalid type given. String expected",
            "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"
        }
    ]
}

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": "If phone is provided, country_code is required",
            "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": "If phone is provided, number is required",
            "location": "body.payer.person.phone.number"
        }
    ]
}

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"
        }
    ]
}

Search API

Route not found

Status 404 Not Found

{
    "error": "route_not_found"
}

Bad Request

Status 400 Bad Request

Initial date not entered

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

Initial date is invalid

{
    "errors": [
        {
            "message": "The parameter does not appear to be a valid UTC DateTime",
            "location": "params.initial_transaction_date"
        }
    ]
}

Final date not entered

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

Final date is invalid

{
    "errors": [
        {
            "message": "The parameter does not appear to be a valid UTC DateTime",
            "location": "params.final_transaction_date"
        }
    ]
}

Transaction final date greater than initial date

{
    "errors": [
        {
            "message": "The final_transaction_date param must be greater than initial_transaction_date",
            "location": "params.final_transaction_date"
        }
    ]
}

Invalid page number

{
    "errors": [
        {
            "message": "The input is not between '1' and '2147483647', inclusively",
            "location": "params.page"
        }
    ]
}

Invalid amount per page

{
    "errors": [
        {
            "message": "The input is not between '1' and '10', inclusively",
            "location": "params.max_results"
        }
    ]
}

Refund API

Bad Request

Status 400 Bad Request

Refund notification_url errors

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

Refund amount errors

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

Refund reference errors

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

Refund domain errors

Status 422 Unprocessable Entity

{
    "error": "refund_already_requested"
},
{
    "error": "refund_amount_is_greater_than_limit"
},
{
    "error": "refund_amount_is_greater_than_transaction"
},
{
    "error": "transaction_status_does_not_accept_refund"
},
{
    "error": "payment_does_not_accept_refund"
},
{
    "error": "expired_refund_request"
},
{
    "error": "partial_refund_not_allowed"
}