Skip to main content

V1CreatePaymentBody

    payment_method stringrequired

    Possible values: [DEBIT, CREDIT]

    Payment method used.

    amount_total numberrequired

    Payment amount in cents.

    currency_tag stringrequired

    Possible values: [BRL, USD]

    Three-letter code of the payment currency.

    buyer_name stringrequired

    Buyer name.

    buyer_email stringrequired

    Buyer email address.

    buyer_phone stringrequired

    Buyer phone number.

    buyer_document stringrequired

    Buyer document.

    buyer_document_type stringrequired

    Possible values: [CPF, CNPJ]

    Buyer document type.

    installments number

    Number of installments for the payment.

    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.

    buyer_address object
    zip_code objectrequired

    User address zip code.

    street objectrequired

    User address street.

    number objectrequired

    User address number.

    neighborhood object

    User address neighborhood.

    city objectrequired

    User address neighborhood.

    federative_unit objectrequired

    User address federative unit.

    country objectrequired

    User address country.

    complement object

    User address complement.