Skip to main content

V1CreatePayinBody

    country stringrequired

    Possible values: [BRA, ARG, CHL, PER, MEX]

    Country ISO 3166-1-alpha-3 code for the payment.

    payment_method stringrequired

    Possible values: [CREDIT_CARD, DEBIT_CARD, CASH, BANK_TRANSFER, OXXO, YAPE, ASTRO_PAY_BANK_TRANSFER, QR]

    Payment method used in the transaction.

    amount_total numberrequired

    Payment amount in cents. Must be at least 100 cents.

    currency_tag object required

    Possible values: [MXN, PEN, CLP, ARS, USD, BRL]

    Payment currency ISO 4217 code.

    oneOf

    string

    Possible values: [BRL]

    third_part_name stringrequired

    Third Part first name.

    third_part_last_name stringrequired

    Third Part last name.

    third_part_email stringrequired

    Third Part email address.

    third_part_phone stringrequired

    Third Part phone number.

    third_part_document stringrequired

    Third Part document.

    third_part_document_type object required

    Possible values: [CPF, CNPJ, RUT, PP, DNI, CE, PAS, RUC, DNI, CUIT, CUIL, RFC, CURP, PASSPORT, TAXSTATEMENT]

    Third Part document type.

    oneOf

    string

    Possible values: [CPF, CNPJ]

    third_part_address_zip_code stringrequired

    User Address Zip Code.

    third_part_address_street stringrequired

    User Address Street.

    third_part_address_number stringrequired

    User Address number.

    third_part_address_city stringrequired

    User Address City.

    third_part_address_state stringrequired

    User Address State.

    third_part_address_country stringrequired

    User Address Country.

    third_part_address_complement string

    User Address Complement.

    third_part_address_neighborhood string

    User Address Neighborhood (for acquiring payments).

    payment_card object
    card_number stringrequired

    Card number.

    card_cvv stringrequired

    Card CVV.

    card_name stringrequired

    Card Holder Name.

    card_expiry_date stringrequired

    Card Expiry Date in MM-YYYY format.

    installments number

    Number Of Installments. Allowed values: 1 to 12. Only for CREDIT payment method.

    auto_capture boolean

    Whether to capture the payment value on success or later through the capture transaction endpoint. For card payments only (required for acquiring payments).

    language stringrequired

    Possible values: [pt, en, es]

    Language ISO 639-1 code for the payment.

    expiration_time_minutes number

    Expiration time in minutes for the payment.

    platform string

    Possible values: [WEB, MOBILE]

    Platform where the payment is being made (WEB or MOBILE).

    is_recurrent boolean

    Indicates if the payment is recurrent.

    is_redirect boolean

    Whether to use redirect flow for payment processing. Default is true. If your company do not have a PCI certificate, you MUST send this field with "true"

    redirect_url string

    Redirect URL for payment success and error.

    virtual_account_id string

    Virtual Account ID for AstroPay Bank Transfer.