Pedidos

Criar transação

POST
/orders

Cria um novo pedido de pagamento. Suporta PIX, Cartão de Crédito e Boleto Bancário.

AuthorizationBasic <token>

Chave de Cash-In no formato Basic Auth

In: header

Request Body

application/json

amount*integer

Valor do pedido em centavos

Range1 <= value
payment_method*string

Método de pagamento

Value in"pix" | "card" | "boleto"
customer*
description?string

Descrição do pedido

card?

Dados do cartão (obrigatório quando payment_method é "card")

boleto?

Dados do boleto (obrigatório quando payment_method é "boleto")

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://api.exemplo.com/v1/orders" \  -H "Content-Type: application/json" \  -d '{    "amount": 10000,    "payment_method": "pix",    "customer": {      "name": "João Silva",      "email": "joao@exemplo.com",      "document": 12345678900    },    "description": "Pagamento de serviço"  }'

{
  "id": "ord_123456789",
  "status": "pending",
  "amount": 10000,
  "currency": "BRL",
  "payment_method": "pix",
  "payload": {
    "code": "00020126580014br.gov.bcb.pix0136123e4567-e12b-12d1-a456-426655440000520400005303986540510.005802BR5925NOME DO RECEBEDOR6009SAO PAULO62070503***63041D3D"
  },
  "payment_link": "https://pagamento.exemplo.com/pay/ord_123456789",
  "customer": {
    "name": "João Silva",
    "email": "joao@exemplo.com"
  },
  "created_at": "2024-01-15T10:00:00Z",
  "expires_at": "2024-01-15T11:00:00Z"
}

{
  "error": "Invalid request",
  "details": {
    "field": "amount",
    "message": "Amount must be greater than 0"
  }
}
{
  "error": "Unauthorized",
  "details": {
    "message": "Invalid or missing token"
  }
}
{
  "error": "Validation error",
  "details": {
    "field": "payment_method",
    "message": "Invalid payment method"
  }
}