Initiate a payment by Pix key.

post https://accounts.voluti.com.br/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).

Body Params

pixKey

string

required

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

creditorDocument

string

priority

string

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.

description

string

This message accompanies the Pix transfer.

paymentFlow

string

expiration

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

x-idempotency-key

string

required

Unique request identifier to support idempotency.

Responses

503

Service unavailable

504

Gateway timeout

Language

Credentials

OAuth2

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://accounts.voluti.com.br/api/v2/pix/payments/dict \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '{"expiration":600}'


xxxxxxxxxx
 
1
{
2
  "endToEndId": "string",
3
  "eventDate": "2025-04-12T13:15:51.598Z",
4
  "id": 0,
5
  "payment": {
6
    "amount": 0
7
  },
8
  "type": "string"
9
}

202Accepted

400Bad request

401Unauthorized

403Access denied

412Precondition Failed

422Unprocessable entity

429Rate limit exceeded

500Internal server error