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

POST 
https://checkout-api-sandbox.picpay.com/api/v1/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.

application/json

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

required

Informações do cliente/comprador.

name String (string)required

Possible values: non-empty and <= 255 characters, 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)]

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.

transactions

object[]

required

Possible values: >= 1, <= 1

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

Array [

amount int32required

Possible values: >= 1

Valor do pagamento em centavos

pix

object

expiration int32

Possible values: >= 1

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

]

Responses

200

OK

application/json

Schema

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 stringdeprecated

credit

object

nsu string

cardNumber string

authorizationCode string

Possible values: >= 6 characters and <= 36 characters

authorizationResponseCode string

brand string

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

cardholderName string

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

cardholderDocument String (string)

Possible values: Value must match regular expression ^\d{11}$|^\d{14}$|^[A-Z0-9]{8,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)]

reasonCode int32

Código de mensagem erro quando status da cobrança for DENIED, normativo 021 Abecs. Procure no menu da documentação Códigos e retornos da API.

reasonMessage string

Mensagem de erro que acompanha o atributo reasonCode que ocorre quando status da cobrança for DENIED, normativo 021 Abecs. Procure no menu da documentação Códigos e retornos da API.

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)

]

Example (from schema)

{
  "merchantChargeId": "string",
  "id": "string",
  "chargeStatus": "PRE_AUTHORIZED",
  "amount": 0,
  "originalAmount": 0,
  "refundedAmount": 0,
  "transactions": [
    {
      "paymentType": "CREDIT",
      "amount": 0,
      "originalAmount": 0,
      "refundedAmount": 0,
      "transactionStatus": "PRE_AUTHORIZED",
      "createdAt": "2022-05-01T16:00:00-03:00",
      "updatedAt": "2022-05-01T16:00:00-03:00",
      "transactionId": "string",
      "softDescriptor": "string",
      "credit": {
        "nsu": "string",
        "cardNumber": "string",
        "authorizationCode": "string",
        "authorizationResponseCode": "string",
        "brand": "VISA",
        "cardholderName": "string",
        "cardholderDocument": "string",
        "expirationMonth": 0,
        "expirationYear": 0,
        "installmentNumber": 0,
        "installmentType": "NONE",
        "reasonCode": "string",
        "reasonMessage": "string"
      },
      "wallet": {
        "qrCode": "string",
        "qrCodeBase64": "string",
        "expiresAt": "2022-05-01T16:00:00-03:00"
      }
    }
  ]
}

Example

{
  "merchantChargeId": "8086bfd7-6241-4f76-81d8-70460533ce74",
  "id": "ed50d469-ae7d-4a3d-a946-6e399cb981bb",
  "chargeStatus": "PRE_AUTHORIZED",
  "amount": 1000,
  "originalAmount": 1000,
  "refundedAmount": 0,
  "transactions": [
    {
      "paymentType": "PIX",
      "amount": 1000,
      "originalAmount": 1000,
      "refundedAmount": 0,
      "transactionStatus": "PENDING",
      "createdAt": "2023-11-08T11:50:21-03:00",
      "updatedAt": "2023-11-08T11:50:21-03:00",
      "transactionId": "2a50d469-ae7d-4a3d-a946-6e399cb981dh",
      "errorMessage": null,
      "pix": {
        "qrCode": "00020101021226940014COM.PICPAY.P2B0172......",
        "qrCodeBase64": "data:image/png;base64......",
        "endToEndId": "E00416911112501234429olrr6BQh8vW"
      }
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

message stringrequired
success booleanrequired
businessCode string

errors

object[]

Array [

message string

field string

]

Example (from schema)

{
  "message": "string",
  "success": true,
  "businessCode": "string",
  "errors": [
    {
      "message": "must be a well-formed UUID string",
      "field": "merchantChargeId"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

message stringrequired
success booleanrequired
businessCode string

errors

object[]

Array [

message string

field string

]

Example (from schema)

{
  "message": "string",
  "success": true,
  "businessCode": "string",
  "errors": [
    {
      "message": "must be a well-formed UUID string",
      "field": "merchantChargeId"
    }
  ]
}

Example

{
  "message": "Authorization token not found.",
  "success": false,
  "errors": {
    "message": "Authorization token not found",
    "field": "Authorization Token"
  }
}

415

Unsupported Media Type

application/json

Schema

Schema

message stringrequired
success booleanrequired
businessCode string

errors

object[]

Array [

message string

field string

]

Example (from schema)

{
  "message": "string",
  "success": true,
  "businessCode": "string",
  "errors": [
    {
      "message": "must be a well-formed UUID string",
      "field": "merchantChargeId"
    }
  ]
}

Example

{
  "message": "Request object is invalid or incorrectly formatted",
  "success": false,
  "errors": null
}

500

Internal Server Error

application/json

Schema

Schema

message stringrequired
success booleanrequired
businessCode string

errors

object[]

Array [

message string

field string

]

Example (from schema)

{
  "message": "string",
  "success": true,
  "businessCode": "string",
  "errors": [
    {
      "message": "must be a well-formed UUID string",
      "field": "merchantChargeId"
    }
  ]
}

Example

{
  "message": "Internal Server Error",
  "success": false,
  "errors": null
}

• curl

• CURL

Request Collapse all

Base URL

https://checkout-api-sandbox.picpay.com/api/v1

Auth

Bearer Token

Parameters

caller-origin — header

Body required

• Example (from schema)
• Criação de cobrança com tipo de pagamento Pix

{
  "paymentSource": "GATEWAY",
  "smartCheckoutId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "merchantChargeId": "string",
  "customer": {
    "name": "Pessoa da Silva",
    "email": "email@xpto.com",
    "documentType": "CPF",
    "document": "22926590008",
    "phone": {
      "countryCode": "55",
      "areaCode": "27",
      "number": "999999999",
      "type": "MOBILE"
    }
  },
  "deviceInformation": {
    "ip": "string",
    "id": "string",
    "ipCountryCode": "string",
    "ipCity": "string",
    "ipRegion": "string",
    "sessionId": "string"
  },
  "transactions": [
    {
      "amount": 100,
      "pix": {
        "expiration": 0
      }
    }
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!