API Reference

Initiate a payment by QR Code.

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

This endpoint allows the request of a Pix payment order (cash-out) using data that follow the specifications of the Banco Central do Brasil and that can be expressed in a QRCode. This data is also known as 'Copy and paste', as it can be copied in text format and inserted as the creditor's identifier.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
string
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