Pular para o conteúdo principal

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

    Inclua a propriedade 'caller-origin' como uma string no header das requisições REST somente se a aplicação for uma plataforma de e-commerce, caso contrário, não inclua.

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

    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

    required

    Informações do cliente/comprador.

    name Stringrequired

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

    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 DocumentTypeEnumrequired

    Possible values: [CPF, CNPJ, PASSPORT]

    document Stringrequired

    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

    Possible values: >= 1, <= 1

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

  • Array [

    • paymentType stringrequired

    Possible values: [CREDIT, WALLET, PIX]

    Enum [ CREDIT(Cartão de credito), WALLET(QRCode PicPay), PIX (Pix)]

    amount int32required

    Possible values: >= 1

    Payment amount in cents

    softDescriptor string
    transactionId string

    pix

    object

    expiration int32

    Possible values: >= 1

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

  • ]

    • deviceInformation

    object

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

    ip IP

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

    id IDnullable

    ID exclusivo do dispositivo do cliente.

    ipCountryCode IPCountryCodenullable

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

    ipCity IPCitynullable

    A cidade estimada do endereço IP.

    ipRegion IPRegionnullable

    O endereço IP da região estimado.

    sessionId SessionIDnullable

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

    sourceId String

    Use este campo para declarar a origem de uma cobrança

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
    softDescriptor string
    errorMessage string

    credit

    object

    nsu string
    cardNumber string
    authorizationCode string
    authorizationResponseCode string
    brand string

    Possible values: [VISA, MASTERCARD, AMEX, ELO, HIPERCARD]

    cardholderName string

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

    cardholderDocument String

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

    expirationMonth int32
    expirationYear int32
    installmentNumber int32
    installmentType string

    Possible values: [NONE, MERCHANT]

    Default value: NONE

    Enum [ NONE(Transação a vista), MERCHANT(Transação parcelada pelo lojista, ou seja, sem juros)]

    wallet

    object

    Wallet response

    qrCode string
    qrCodeBase64 string
    expiresAt date-time

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

  • ]

Loading...