API Reference

Transfer By Pix Key

post
https://secureapi.pagstar-prod.onz.software/api/v2/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
Defaults to 11111111111

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

string
required
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

Descrição da transação

int32
Defaults to 600

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

payment
object
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

Updated 10 months 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 10 months ago