POST /payments/order - EconPay API

curl --request POST \
  --url https://api.econpay.com.br/payments/order \
  --header 'Authorization: Bearer SEU_TOKEN_JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "access_token": "SEU_ACCESS_TOKEN",
    "customer": {
      "name": "João da Silva",
      "email": "[email protected]",
      "document": "12345678900",
      "phone": {
        "country_code": "55",
        "area_code": "11",
        "number": "999999999"
      }
    },
    "items": [{
      "name": "Produto Teste",
      "quantity": 1,
      "price": 10000
    }],
    "payment": {
      "type": "pix",
      "installments": 1
    },
    "shipping": {
      "name": "Digital",
      "price": 0
    },
    "subtotal": 10000,
    "total": 10000
  }'

{
  "success": true,
  "transaction": {
    "id": 123,
    "order_number": "ORD-20240122-123456",
    "status": "PENDING",
    "amount": 10000,
    "payment_type": "pix",
    "pix_qr_code": "00020126580014br.gov.bcb.pix...",
    "pix_qr_code_url": "https://api.econpay.com.br/qrcode/123.png",
    "created_at": "2024-01-22T10:30:00Z"
  }
}

POST

payments

order

curl --request POST \
  --url https://api.econpay.com.br/payments/order \
  --header 'Authorization: Bearer SEU_TOKEN_JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "access_token": "SEU_ACCESS_TOKEN",
    "customer": {
      "name": "João da Silva",
      "email": "[email protected]",
      "document": "12345678900",
      "phone": {
        "country_code": "55",
        "area_code": "11",
        "number": "999999999"
      }
    },
    "items": [{
      "name": "Produto Teste",
      "quantity": 1,
      "price": 10000
    }],
    "payment": {
      "type": "pix",
      "installments": 1
    },
    "shipping": {
      "name": "Digital",
      "price": 0
    },
    "subtotal": 10000,
    "total": 10000
  }'

{
  "success": true,
  "transaction": {
    "id": 123,
    "order_number": "ORD-20240122-123456",
    "status": "PENDING",
    "amount": 10000,
    "payment_type": "pix",
    "pix_qr_code": "00020126580014br.gov.bcb.pix...",
    "pix_qr_code_url": "https://api.econpay.com.br/qrcode/123.png",
    "created_at": "2024-01-22T10:30:00Z"
  }
}

Descrição

Endpoint unificado para processar pagamentos. Suporta os seguintes métodos de pagamento:

PIX - Pagamento instantâneo com QR Code
Boleto - Boleto bancário registrado

Valor Mínimo: R$ 5,00 (500 centavos). Valores menores serão rejeitados.

Valores em Centavos: Todos os valores monetários devem ser enviados em centavos. R$ 100,00 = 10000 centavos.

Headers

Authorization

string

required

Bearer token JWT obtido no login

Request Body

access_token

string

required

Token de acesso do estabelecimento (obtido no dashboard)

payment_link_id

string

ID do link de pagamento (opcional)

customer

object

required

Dados do cliente

Show properties

customer.name

string

required

Nome completo do cliente

customer.email

string

required

Email do cliente

customer.document

string

required

CPF ou CNPJ (apenas números)

customer.ip

string

Endereço IP do cliente (recomendado para antifraude)

customer.phone

object

required

Show properties

customer.phone.country_code

string

required

Código do país (ex: “55” para Brasil)

customer.phone.area_code

string

required

DDD (ex: “11”)

customer.phone.number

string

required

Número do telefone (ex: “999999999”)

customer.address

object

Show properties

customer.address.line_1

string

Endereço (rua, número)

customer.address.line_2

string

Complemento

customer.address.zip_code

string

CEP (apenas números)

customer.address.city

string

Cidade

customer.address.state

string

Estado (UF)

customer.address.country

string

País (código ISO, ex: “BR”)

items

array

required

Lista de itens do pedido

Show properties

items[].name

string

required

Nome do produto/serviço

items[].quantity

number

required

Quantidade

items[].price

number

required

Preço unitário em centavos

payment

object

required

Dados do pagamento

Show properties

payment.type

string

required

Tipo de pagamento: pix ou invoice

payment.installments

number

required

Número de parcelas (sempre 1 para PIX e Boleto)

shipping

object

required

Dados de envio

Show properties

shipping.name

string

required

Nome do método de envio (ex: “Sedex”, “Digital”)

shipping.price

number

required

Valor do frete em centavos (0 para digital)

subtotal

number

required

Subtotal em centavos (soma dos itens)

total

number

required

Total em centavos (subtotal + frete)

splitParticipants

array

Participantes do split (opcional, para divisão de valores)

Show properties

splitParticipants[].accessToken

string

required

Access token do participante

splitParticipants[].merchantType

string

required

Tipo: PRIMARY ou SECONDARY

splitParticipants[].type

string

required

Tipo de divisão: PERCENTAGE ou FIXED

splitParticipants[].chargeFee

boolean

required

Se este participante paga as taxas

splitParticipants[].discountGrossAmount

boolean

required

Se desconta do valor bruto

splitParticipants[].amountSplit

number

required

Valor em centavos (FIXED) ou porcentagem em centavos (PERCENTAGE)

Response

success

boolean

Indica se a operação foi bem-sucedida

transaction

object

Show properties

number

ID da transação

order_number

string

Número do pedido (único)

status

string

Status da transação: PENDING, APPROVED, FAILED

amount

number

Valor em centavos

payment_type

string

Tipo de pagamento usado

pix_qr_code

string

String do QR Code PIX (apenas para PIX)

pix_qr_code_url

string

URL da imagem do QR Code (apenas para PIX)

boleto_url

string

URL do boleto (apenas para boleto)

boleto_barcode

string

Código de barras do boleto (apenas para boleto)

created_at

string

Data de criação (ISO 8601)

curl --request POST \
  --url https://api.econpay.com.br/payments/order \
  --header 'Authorization: Bearer SEU_TOKEN_JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "access_token": "SEU_ACCESS_TOKEN",
    "customer": {
      "name": "João da Silva",
      "email": "[email protected]",
      "document": "12345678900",
      "phone": {
        "country_code": "55",
        "area_code": "11",
        "number": "999999999"
      }
    },
    "items": [{
      "name": "Produto Teste",
      "quantity": 1,
      "price": 10000
    }],
    "payment": {
      "type": "pix",
      "installments": 1
    },
    "shipping": {
      "name": "Digital",
      "price": 0
    },
    "subtotal": 10000,
    "total": 10000
  }'

{
  "success": true,
  "transaction": {
    "id": 123,
    "order_number": "ORD-20240122-123456",
    "status": "PENDING",
    "amount": 10000,
    "payment_type": "pix",
    "pix_qr_code": "00020126580014br.gov.bcb.pix...",
    "pix_qr_code_url": "https://api.econpay.com.br/qrcode/123.png",
    "created_at": "2024-01-22T10:30:00Z"
  }
}

Métodos de Pagamento

PIX
Boleto

Pagamento PIX

Aprovação instantânea (geralmente em segundos)
QR Code válido por 30 minutos
Disponível 24/7
Sem taxas para o cliente final

Resposta inclui:

pix_qr_code: String EMV do QR Code
pix_qr_code_url: URL da imagem do QR Code

Status:

PENDING: Aguardando pagamento
APPROVED: Pago (webhook enviado)

Boleto Bancário

Vencimento configurável
Registro automático
Código de barras e linha digitável

Resposta inclui:

boleto_url: URL do PDF do boleto
boleto_barcode: Código de barras
boleto_digitable_line: Linha digitável

Status:

PENDING: Aguardando pagamento
APPROVED: Pago (webhook enviado)

Próximos Passos

Reembolso

Processar estornos

Webhooks

Receber notificações

Listar Transações

Consultar pagamentos

Erros

Códigos de erro

GET /auth POST /payments/reversal

​Descrição

​Headers

​Request Body

​Response

​Métodos de Pagamento

​Pagamento PIX

​Boleto Bancário

​Próximos Passos

Reembolso

Webhooks

Listar Transações

Erros

Descrição

Headers

Request Body

Response

Métodos de Pagamento

Pagamento PIX

Boleto Bancário

Próximos Passos