Skip to content

Search is only available in production builds. Try building and previewing the site to test it out locally.

Field validation

Every request is validated before anything is created. An invalid request answers 422 with errors, a map of each invalid field to its messages, and nothing is created or charged.

Common formats

DataFormat
StringsUTF-8. Up to 255 characters unless the field says otherwise. Free text must not contain HTML tags.
AmountsJSON number, positive, at most two decimals (25.50).
BooleansJSON true / false. Send real booleans: other values may be read as missing ("The mobile field is required.").
CountriesISO 3166-1 alpha-3: MEX, CHL, BRA.
CurrenciesISO 4217: USD, MXN.
Phone numbersSend them in international format (+52…).
EmailsValid address; production also checks that the domain can receive mail.
URLs you send (callbacks, return URLs)Absolute https:// URLs. Callback URLs must not embed credentials or point to private addresses.
Field namessnake_case.

By product

  • Pay-In: the customer fields depend on the payment method. Read them from required_fields, mandatory_fields and document_types of Get payment methods. Rules, accepted documents by country and real error messages: Payer data & documents.
  • Pay-Out: see the field tables of the Pay-Out guide.