Pular para o conteúdo principal
Versão: 1.5.0

Solicitação de geração de cobrança com QRCode PIX

POST 
/charge/pix

Solicitação de geração de cobrança com QRCode PIX

Request​

Header Parameters

    caller-origin string

    String opcional que identifica a plataforma de e-commerce ou sistema de integração utilizado pelo cliente para enviar a requisição, como 'vtex', 'irroba', etc.

Body

required

    paymentSource stringrequired

    Possible values: [CHECKOUT, GATEWAY]

    Enum [ CHECKOUT(Transações realizadas a partir do checkout padrão e lightBox), GATEWAY(Transações realizadas utilizando diretamente a api)]

    smartCheckoutId uuid

    SmartCheckoutID definido pelo sistema (obrigatório para checkout padrão ou lightBox)

    merchantChargeId String (string)

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

    Identificador externo único da cobrança, definido pelo sistema do comerciante. Este campo deve ser exclusivo para cada cobrança, pois é utilizado para rastrear e identificar individualmente as transações no sistema. Caso não seja passado, será gerado internamente. Atenção: a reutilização de um merchantChargeId para múltiplas cobranças resultará em falhas na criação de novas cobranças.

    customer

    object

    Informações do cliente/comprador.

    name String (string)required

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

    Nome do cliente.

    email emailrequired

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

    E-mail do cliente.

    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}$

    CPF, CNPJ ou PASSAPORT do cliente.

    phone

    object

    numero de telefone.

    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

    Uma transação a ser realizada dentro da cobrança.

  • Array [

    • amount int32required

    Possible values: >= 1

    Payment amount in cents

    pix

    object

    expiration int32

    Expiração qrcode pix em segundos. Padrão = 900s

  • ]

    • deviceInformation

    object

    Contém informações do dispositivo (obrigatório para análise antifraude)

    ip IP (string)

    O IP do dispositivo usado para realizar a transação.

    id ID (string)nullable

    ID exclusivo do dispositivo do cliente.

    ipCountryCode IPCountryCode (string)nullable

    O código do país do endereço do cliente final. (Ex.: BRA)

    ipCity IPCity (string)nullable

    A cidade estimada do endereço IP.

    ipRegion IPRegion (string)nullable

    O endereço IP da região estimado.

    sessionId SessionID (string)nullable

    Um identificador da sessão no dispositivo a partir do qual este evento foi gerado.

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(Cartão de credito), 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...