API Reference

Gerar Pix

Gera um Pix com vencimento dinâmico.

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…

Gerar Pix

Gere um Pix com uma expiração padrão de 30 minutos, mas também tenha a flexibilidade de definir o tempo de expiração desejado, inserindo o valor de sua preferência em segundos no campo "expiration_time".

No Body devemos passar alguns valores para realizar a geração do Pix.
Abaixo temos um exemplo de como inserir estes dados usando JSON.


❗️

Informação

Os dois parâmetros para requisição nesta rota de geração do Pix: partner_token_api e partner_id. Um dos dois deve ser informado no ato da geração.


{ "value": 1, "message": "teste pix", "partner_token_api": "6G9AEOF5vC5O3Bhs9beJi5xxxxxyyyya", "usuario": "Usuário", "usuario_id": 1, "captura_id": 9 } ou { "value": 1, "message": "teste pix", "partner_id": 3, "usuario": "Usuário", "usuario_id": 1, "captura_id": 9 }

A seguir, apresenta-se uma tabela contendo os Ids das capturas e suas respectivas descrições:

Id da CapturaDescrição
1NAO IDENTIFICADO
7PIX PORTAL CLIENTE
9PIX API
12PIX APP
21E-COMMERCE
25RECORRENCIA PIX
28FATURA PIX

É necessário passar o Token API do estabelecimento no header "Authorization", e no "Content-Type" preenchê-lo com o valor do conteúdo que está sendo enviado, neste caso usamos "application/json".

Abaixo temos um exemplo de como inserir estes dados usando JSON.

{ "Content-Type": "application/json", "Authorization": "Bearer $TOKEN_API" }
Body Params
double
required

Valor do Pix

string
required

Mensagem que exemplifica o Pix.

string

Usuario que realiza a requisição.

int32

Id do usuário da requisição.

int32

Id da captura do Pix.

string

Tempo de expiração do Pix em segundos.

int32
required

Id do parceiro configurado no EC

string
required

Token do parceiro configurado no EC

Headers
string
required

Header no qual o valor é o Token Api do estabelecimento. Ex.: Bearer $TOKEN_API

string
required

Header que recebe o tipo do conteúdo a ser enviado. Ex.: application/json

Responses

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain