Skip to main content
POST
Criar pagamento por chave Pix

Comportamento observado

  • pix_key_type é sempre obrigatório. Se pix_key_value estiver vazio e document_number existir, o Gateway copia o documento para o valor da chave, mas não infere o tipo.
  • O validador torna document_number condicional em parte das configurações, mas o fluxo de pagamento o lê sem fallback. Envie sempre um CPF ou CNPJ válido.
  • O Gateway normaliza chaves de email para minúsculas e remove caracteres não numéricos das chaves de documento.
  • O controller não valida bank_accounts_allowed, mas o pagamento Celcoin transforma essa lista em uma relação de contas de crédito permitidas.
  • Os campos opcionais de identificação são persistidos ou registrados no evento conforme o processador. O controller desta rota não valida nome, sobrenome ou email.
  • Se pix_message não for enviado, o Gateway usa Pagamento para: {alias do processador}.
  • Quando não há QR Code, qrcode_image é uma string vazia.
  • A validação de titularidade, DICT e bancos permitidos depende do processador ativo.
  • Para LBPay, repetir o mesmo merchant_transaction_id com a mesma intenção devolve a transação existente com HTTP 200. O Gateway mantém o processador original, não cria outra transferência no provedor e não dispara um segundo webhook payment. Se a intenção mudar, o Gateway devolve HTTP 409.
Os exemplos usam identificadores e credenciais sintéticos. Os resultados do processador dependem do credenciamento e da configuração do estabelecimento.

Authorizations

Authorization
string
header
required

Token de acesso fornecido para o estabelecimento.

Body

application/json
amount
number
required

Valor em reais, com no máximo duas casas decimais. Deve ser maior que zero e menor que 99.999.999 antes da aplicação dos limites do processador.

Must be a multiple of 0.01
merchant_transaction_id
string
required

Identificador da transação no estabelecimento.

Maximum string length: 255
pix_key_type
enum<string>
required

Tipo da chave Pix.

Available options:
phone,
document,
email,
random
document_number
string | null
required

CPF ou CNPJ. A obrigatoriedade depende da configuração do processador.

pix_key_value
string

Valor da chave Pix. O formato é validado conforme pix_key_type.

pix_message
string | null

Mensagem Pix. Máximo de 140 caracteres.

Maximum string length: 140
first_name
string | null

Nome opcional. O controller desta rota não valida o campo.

Maximum string length: 255
last_name
string | null

Sobrenome opcional. O controller desta rota não valida o campo.

Maximum string length: 255
email
string<email> | null

Email opcional. O controller desta rota não valida o campo.

Maximum string length: 255
ip_address
string | null

Endereço IP do pagador. O valor segue para o processador e para o evento da transação.

phone_number
string | null

Telefone lido pelo processador e persistido na transação. Quando o telefone for exigido, envie também mobile_phone com o mesmo valor.

Maximum string length: 15
bank_accounts_allowed
object[] | null

Contas bancárias permitidas para o pagamento. O controller não valida o formato; os campos aceitos e seu efeito dependem do processador ativo.

processor_id
string<uuid> | null

UUID do processador. Na seleção comum, o Gateway usa o primeiro Pix habilitado por precedência; este campo só restringe a seleção quando source é settlement.

source
enum<string> | null

Origem da transação. Quando omitida em uma cobrança, o Gateway assume player.

Available options:
player,
settlement,
vendor,
funding,
internal,
balancing,
null
birth_date
string<date> | null

Data de nascimento.

tag
string | null

Tag da transação. Conforme a configuração do estabelecimento, pode ser obrigatória, livre ou restrita a CPF ou CNPJ. Tags que contêm internal suprimem os webhooks de pagamento.

Maximum string length: 50

Response

Transação criada ou atualizada.

transaction
object
required