Skip to main content
O método de pagamento influencia no modelo do webhook enviado. Alguns campos só estarão disponíveis em determinados métodos, identificados pelo campo paymentMethod.

​
Pix

O QR Code Pix tem validade de 45 dias a partir da hora em que foi criado.
{
  "paymentMethod": "pix",
  "pix": {
    "qrCode": "00020101021226770014BR.GOV.BCB.PIX...",
    "expirationDate": "2024-08-22 17:25:14.804059+00:00"
  }
}
​
pix.qrCode
string
String do QR Code Pix para exibição ou geração de imagem.
​
pix.expirationDate
string
Data e hora de expiração do Pix.

​
Boleto

{
  "paymentMethod": "boleto",
  "barcode": "23790001089019590089069000595806111810000000555",
  "boletoUrl": "https://aarinip-api.smartcore.aarin.com.br/boleto-receipts/...",
  "expirationDate": "2024-08-25 14:41:19.363563+00:00"
}
​
barcode
string
Código de barras do boleto.
​
boletoUrl
string
URL para visualização e impressão do boleto em PDF.
​
expirationDate
string
Data de vencimento do boleto.

​
Cartão de Crédito

{
  "paymentMethod": "credit_card",
  "paymentMethodName": "Cartão de Crédito",
  "installments": 1,
  "card": {
    "holderName": "Example",
    "lastDigits": "8694",
    "brand": null
  }
}
​
card.holderName
string
Nome do titular do cartão.
​
card.lastDigits
string
Últimos 4 dígitos do cartão.
​
card.brand
string | null
Bandeira do cartão. Pode ser null em alguns casos.
​
installments
number
Número de parcelas do pagamento.