Skip to main content
POST
/
payin
Criar Pagamento
curl --request POST \
  --url https://api.example.com/payin \
  --header 'Content-Type: application/json' \
  --data '
{
  "paymentMethod": "<string>",
  "amount": 123,
  "referenceId": "<string>",
  "webhookUrl": "<string>",
  "customer": {
    "name": "<string>",
    "email": "<string>",
    "document": "<string>",
    "phone": "<string>",
    "address": {
      "street": "<string>",
      "number": "<string>",
      "neighborhood": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipCode": "<string>"
    }
  },
  "items": [
    {
      "title": "<string>",
      "quantity": 123,
      "unitPrice": 123,
      "tangible": true
    }
  ]
}
'
{
  "id": "<string>",
  "externalId": "<string>",
  "referenceId": "<string>",
  "status": "<string>",
  "pix": {}
}

​
Body Parameters

​
paymentMethod
string
required
O método de pagamento escolhido. Valores aceitos: PIX, CREDIT_CARD, BOLETO.
​
amount
integer
required
O valor do pedido em centavos (ex: 10050 para R$ 100,50).
​
referenceId
string
required
Um identificador único do seu sistema para este pedido.
​
webhookUrl
string
URL que receberá notificações de mudança de status (Webhooks).
​
customer
object
required
Dados do cliente pagador.
​
items
array
Lista de itens do pedido.

​
Exemplo de Requisição

{
  "paymentMethod": "PIX",
  "amount": 10050,
  "referenceId": "pedido_12345",
  "webhookUrl": "https://seu-site.com/webhook",
  "customer": {
    "name": "João da Silva",
    "email": "joao@email.com",
    "document": "12345678900",
    "phone": "11999998888",
    "address": {
      "street": "Rua das Flores",
      "number": "100",
      "neighborhood": "Centro",
      "city": "São Paulo",
      "state": "SP",
      "zipCode": "01001000"
    }
  },
  "items": [
    {
      "title": "Produto Exemplo",
      "quantity": 1,
      "unitPrice": 10050,
      "tangible": true
    }
  ]
}

​
Resposta (201 Created)

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "externalId": "tx_987654321",
  "referenceId": "pedido_12345",
  "status": "PENDING",
  "amount": 10050,
  "paymentMethod": "PIX",
  "pix": {
    "qrcode": "00020126580014BR.GOV.BCB.PIX0136123e4567-e89b-12d3-a456-426614174000520400005303986540510.005802BR5913Cicrano de Tal6008BRASILIA62070503***6304E2CA"
  },
  "createdAt": "2023-10-27T10:00:00Z"
}
​
id
string
O ID único do pedido gerado pela plataforma.
​
externalId
string
ID da transação no gateway processador.
​
referenceId
string
Seu ID de referência.
​
status
string
Status inicial do pedido.
​
pix
object
Dados do Pix (qrcode).