Criar um Pagamento Pix

Esse endpoint é utilizado para a geração de um pagamento.

Pré-requisito

Para emitir um pagamento é necessário ter uma Conta Financeira, informada em financial_account_uid. A conta de pagamento que registra a operação é definida em payment_account_uid; se omitida, usa-se a mais antiga vinculada à conta financeira; se informada, deve pertencer à financial_account_uid.

Eventos de Webhook

O evento payment.db.created é disparado nesta operação.

Próximos passos: Após criar um pagamento, você desejará em algum momento enviar um Lote para a instituição financeira. Para isso, utilize o endpoint POST /api/v2/payment/pix_batches.

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

Parametros para criação de um Pagamento

Novo Pagamento Pix.

float | null

Quantia. Opcional, o valor será extraído automaticamente do qrcode.

date | null

Data de Agendamento

uuid
required

UID da Conta Financeira de Origem

uuid | null

Conta de pagamento de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à financial_account_uid.

string | null

ID no seu sistema. Opcional para controle interno.

custom_data
object | null

Hash com chave e valor no formato JSON.

tags
array of strings | null

Tags associadas

tags
string
required

QR Code Copia e Cola

string | null

Identificação do pagamento no comprovante do provedor financeiro. (Uso exclusivo do banco)

Bancos que aceitam esse campo (via API): Itaú

beneficiary
object | null

Dados do beneficiário.

Headers
string

Informar um e-mail válido para contatos.

string

Chave de idempotência para evitar replay de processamento.

Responses

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