API Reference

Initiate a payment by Pix key.

post
https://secureapi.treealhmg-hmg.onz.software/pix/payments/dict

This endpoint allows requesting a Pix payment order (cash-out) using any of the allowed types of pix key: CPF, CNPJ, address e-mail, phone number, EVP (random key).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Any of allowed keys: CPF, CNPJ, address e-mail, phone number, EVP (random key).

string
string

Identificador único obtido através da consulta de chave PIX.
Este parâmetro é opcional e deve ser utilizado para garantir a baixa correta do saldo da ficha de consultas de chave PIX.

string
enum

When the parameter is set to 'HIGH,' it is processed instantly (bypassing the processing queue). The value 'HIGH' is only allowed when the 'creditorDocument' field is defined.

Allowed:
string
string
enum
Defaults to INSTANT

Default value is INSTANT.

  • INSTANT - Payment will happen immediately
  • APPROVAL_REQUIRED - Payment only will happen when the order was approved.
Allowed:
int64
1 to 10800
Defaults to 600

Maximum time (seconds) that an operation can remain in the queue waiting for processing before being cancelled.

payment
object
required
ispbDeny
array of strings

List of codes ISPB (Identificador de Sistema de Pagamentos Brasileiro) to which payments will not be allowed.

ispbDeny
Headers
string
required

Unique request identifier to support idempotency.

Responses

503

Service unavailable

504

Gateway timeout

Updated over 1 year ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago