API Reference

Create Transaction

Endpoint para iniciar uma transação e retornar um código PIX para pagamento. Ao iniciar o pagamento com os dados do devedor, só é aceito pagamento do mesmo CPF informado na transação.

Campos que devem ser informados:

{
  "value": 1.99,
  "description": "Produto x",
  "typePayment": "pix",
  "customer": {
    "firstName": "Nome devedor",
    "lastName": "Sobrenome devedor",
    "cpfCnpj": "00000000000",
    "email": "[email protected]",
    "phone": "64999999999"
  },
  "tags": ["#TAG1", "#TAG2"]
}

Descrição:

ParâmetroObrigatórioTipoDescrição
valueSIMNumberValor da transação PIX gerada.
descriptionNÃOString-
typePaymentSIMStringTipos de pagamentos aceito: "pix"
firstNameSIMString-
lastNameSIMString-
cpfCnpjSIMStringNo momento só é aceito CPF (sem caracteres especiais) e deve ser válido
emailSIMString-
phoneNÃOStringDeve conter 11 dígitos
tagsNÃOArrayArray de Strings para identificação da transação

Respostas esperadas

Status CodeDescrição
200 - OKRequisição bem sucedida.
400 - Bad RequestRequisição inválida. Geralmente acontece por envio de parâmetros inválidos ou falta de dados para a operação.
503 - Server ErrorServidor em manutenção.
Language
Credentials
Click Try It! to start a request and see the response here!