Jump to Content
API Reference
v1.0
Log In
API Reference
Log In
v1.0
API Reference
Obter token de acesso
JUMP TO
TREEAL PAYMENTS
About us
Security
Certificates
Integration Best Practicies
Token Authentication
Getting Started
FAQ
Payment Journey (CashIn)
PIX Related Topics
QRCodes API
Auth
Obter token de acesso
post
Rec
Consultar recorrência.
get
Revisar recorrência.
patch
Consultar lista de recorrências.
get
Criar recorrência.
post
SolicRec
Criar solicitação de confirmação de recorrência.
post
Consultar solicitação de confirmação de recorrência.
get
Revisar solicitação de confirmação de recorrência.
patch
CobR
Criar cobrança recorrente.
put
Revisar cobrança recorrente.
patch
Consultar cobrança recorrente.
get
Criar cobrança recorrente.
post
Consultar lista de cobranças recorrentes.
get
Solicitar retentativa de cobrança.
post
Cob
Criar cobrança imediata.
put
Revisar cobrança imediata.
patch
Consultar cobrança imediata.
get
Criar cobrança imediata.
post
Consultar lista de cobranças imediatas.
get
PayloadLocationRec
Criar location do payload.
post
Consultar locations cadastradas.
get
Recuperar location do payload.
get
Desvincular uma recorrência de uma location.
del
Pix
Consultar Pix.
get
Consultar Pix recebidos.
get
Solicitar devolução.
put
Consultar devolução.
get
Webhook
Configurar o Webhook Pix.
put
Exibir informações acerca do Webhook Pix.
get
Cancelar o webhook Pix.
del
Consultar webhooks cadastrados.
get
WebhookRec
Configurar Webhook.
put
Exibir informações acerca do Webhook.
get
Cancelar o Webhook.
del
WebhookCobR
Configurar Webhook.
put
Exibir informações acerca do Webhook.
get
Cancelar o Webhook.
del
Accounts API
Authentication
Get an access token.
post
Accounts
Get customer account transactions.
get
Get details of transaction.
get
Get customer account balance.
get
Get customer consolidated statement data.
post
Pix
Initiate a payment by QR Code.
post
Initiate a payment using bank information.
post
Initiate a payment by Pix key.
post
Get transaction details by end-to-end-id.
get
Get transaction details by idempotency key.
get
Get pix payment receipt in PDF format.
get
Get pix payment receipt in PDF format.
get
Verify QRCode information via Copy-Paste
post
Billets
Initiate a payment using billet data.
post
Get a billet payment list.
get
Get billet payment operation data by id.
get
Get billet payment receipt in PDF format.
get
Infractions
Returns infractions opened against the customer's account.
get
Get infraction data by infraction ID.
get
Create a defense against an infraction.
post
Webhooks
Webhooks
Get a webhooks list.
get
Get a webhook data.
get
Remove a webhook.
del
Create webhooks for transfer operations.
post
Create webhooks for receiving operations.
post
Create webhooks for refunding operations.
post
Create webhooks for cash-out operations.
post
Create webhooks for infraction operations.
post
Internal Transfers
Create an internal transfer
post
Get internal transfer by EndToEndId
get
Get internal transfer by idempotency key
get
Onboarding API
Onboarding
Create new onboarding
post
Upload onboarding images
post
Treeal - Checkout Bank Service
Pix IN
Get Pix Dynamic
get
Pix Dynamic
post
Invoice
Create Invoice
post
Get Invoice Status
get
Credit Card
/creditcard
get
Powered by
Obter token de acesso
Ask AI
post
https://api.pix-h.treeal.com/oauth/token
Language
Shell
Node
Ruby
PHP
Python
Response
Click
Try It!
to start a request and see the response here!
