Skip to main content
Version: 1.5.0

Request to generate Charge with QRCode PIX

POST 
/charge/pix

Request to generate Charge with QRCode PIX

Request​

Header Parameters

    caller-origin string

    Optional string that identifies the e-commerce platform or integration system used by the customer to send the request, such as 'vtex', 'irroba', etc.

Body

required

    paymentSource stringrequired

    Possible values: [CHECKOUT, GATEWAY]

    Enum [ CHECKOUT(Transactions made from the standard checkout and lightBox), GATEWAY(Transactions carried out using the api directly)]

    smartCheckoutId uuid

    SmartCheckout ID defined by the system (Required to default or lightBox checkout)

    merchantChargeId String (string)

    Possible values: >= 6 characters and <= 36 characters, Value must match regular expression ^([a-zA-Z0-9-]+$)$

    Unique external identifier for the charge, defined by the merchant's system. This field must be unique for each charge, as it is used to individually track and identify transactions in the system. If not provided, it will be generated internally. Caution: reusing a merchantChargeId for multiple charges will result in failures when creating new charges.

    lateCapture boolean

    Inform true to perform an authorization with delayed capture. Default value: false.

    customer

    object

    Related customer (buyer).

    name String (string)required

    Possible values: non-empty, Value must match regular expression ^[\p{L} &\d]+$

    Customer's name.

    email emailrequired

    Possible values: Value must match regular expression ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$

    Customer's e-mail.

    documentType DocumentTypeEnum (string)required

    Possible values: [CPF, CNPJ, PASSPORT]

    document String (string)required

    Possible values: Value must match regular expression ^\d{9}$|^\d{11}$|^[A-Z0-9]{9}$

    Customer's CPF, CNPJ or PASSAPORT. Must match.

    phone

    object

    Customer phone number.

    countryCode stringrequired

    Possible values: <= 3 characters, Value must match regular expression ^[0-9]+$

    areaCode stringrequired

    Possible values: <= 3 characters, Value must match regular expression ^[0-9]+$

    number stringrequired

    Possible values: Value must match regular expression ^[0-9]+$

    type stringrequired

    Possible values: [RESIDENTIAL, COMMERCIAL, TEMPORARY, MOBILE]

    Enum [RESIDENTIAL(Telefone Residencial.), COMMERCIAL(Telefone Comercial.), TEMPORARY(Telefone Temporário.), MOBILE(Celular)]

    transactions

    object[]

    required

    Possible values: >= 1, <= 1

    One transactions to be performed within the charge.

  • Array [

    • paymentType stringrequired

    Possible values: [CREDIT, WALLET, PIX]

    Enum [ CREDIT(Credit card), WALLET(QRCode PicPay), PIX(Pix)]

    amount int32required

    Possible values: >= 1

    Payment amount in cents

    softDescriptor string
    transactionId string

    pix

    object

    expiration int32

    QRcode pix expiration in seconds. Default = 900s

  • ]

    • deviceInformation

    object

    Contains device information (mandatory to antifraud´s analisys)

    ip IP (string)

    The IP of the device used to perform the transaction.

    id ID (string)nullable

    Customer's device unique id

    ipCountryCode IPCountryCode (string)nullable

    The country code of the address of the end customer. (Eg. BRA)

    ipCity IPCity (string)nullable

    The estimated city of ip's address.

    ipRegion IPRegion (string)nullable

    The estimated region ip's address.

    sessionId SessionID (string)nullable

    An identifier of the session in the device from which this event generated

Responses​

OK

Schema

    merchantChargeId string
    id string
    chargeStatus string

    Possible values: [CANCELED, DENIED, ERROR, PAID, PARTIAL, PRE_AUTHORIZED, REFUNDED, CHARGEBACK]

    amount int32
    originalAmount int32
    refundedAmount int32

    transactions

    object[]

  • Array [

    • paymentType string

    Possible values: [CREDIT, WALLET, PIX]

    Enum [ CREDIT(Credit card), WALLET(QRCode PicPay), PIX(Pix)]

    amount int32
    originalAmount int32
    refundedAmount int32
    transactionStatus string

    Possible values: [CANCELED, CHARGEBACK, DENIED, ERROR, EXPIRED, PAID, PARTIALLY_REFUNDED, PENDING, PRE_AUTHORIZED, REFUNDED]

    createdAt date-time

    Formato ISO 8601. Exemplo: 2022-05-01T16:00:00-03:00 (significa que foi criado em 01/05/2022 às 16h no fuso horário -03:00)

    updatedAt date-time

    Formato ISO 8601. Exemplo: 2022-05-01T16:00:00-03:00 (significa que foi atualizado em 01/05/2022 às 16h no fuso horário -03:00)

    transactionId string
    errorMessage string

    pix

    object

    pix response object

    qrCode stringrequired
    qrCodeBase64 stringrequired

  • ]

Loading...