API atual/Referência completa/Gateways de pagamento

Braspag

Cobra por cartão tokenizado ou boleto na Braspag e consulta o pagamento.

Duas rotas públicas para lojas que usam a Braspag como gateway. Ambas exigem o módulo braspag; sem ele respondem 403 module_disabled.

Criar pagamento Braspag

Braspag é um gateway que a loja pode usar para cartão de crédito e boleto. O cartão nunca passa por aqui: o navegador tokeniza com a Silent Order Post da Braspag e você envia só o payment_token. O valor cobrado é o total do pedido. Exige o módulo braspag.

POST/api/v1/storefront/braspag/paymentsPública

Cobra um pedido por cartão (token) ou boleto na Braspag

Corpo da requisição

payment_typestringobrigatório

CreditCardBoleto

Tipo de pagamento, com essa grafia exata.

order_iduuidobrigatório

Pedido a cobrar.

amountinteger

Centavos. O total do pedido prevalece.

customer_namestringobrigatório

Nome do pagador.

customer_cpfstringobrigatório

CPF do pagador.

payment_tokenstring

CreditCard: token do cartão da Silent Order Post.

brandstring

CreditCard: bandeira (Visa, Master...).

installmentsintegerpadrão: 1

CreditCard: parcelas, de 1 a 12. Valores fora da faixa são ajustados ao limite mais próximo.

auto_capturebooleanpadrão: true

CreditCard: captura logo após autorizar. Envie false para só autorizar.

due_datestring

Boleto: vencimento em YYYY-MM-DD. Padrão: 3 dias a partir de hoje.

instructionsstring

Boleto: texto impresso no boleto. Padrão: Não receber após o vencimento.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/storefront/braspag/payments" \
  -H "Content-Type: application/json" \
  -d '{
    "payment_type": "Boleto",
    "order_id": "3f73310d-bfdd-4713-a664-305c08eda58b",
    "customer_name": "Maria Souza",
    "customer_cpf": "12345678909",
    "due_date": "2026-10-14",
    "instructions": "Não aceitar após o vencimento"
  }'

Resposta

201Pagamento criado

json

{
  "payment_id": "b1c2d3e4-f5a6-4b7c-8d9e-0a1b2c3d4e5f",
  "status": "Pending",
  "amount": 22500,
  "boleto_url": "https://boleto.braspag.com.br/xxxx",
  "boleto_barcode": "34191790010104351004791020150008899990000022500"
}

Campos da resposta

payment_idstring

GUID do pagamento na Braspag. É a chave para consultar.

statusstring

NotFinishedAuthorizedPaymentConfirmedDeniedVoidedRefundedPendingAbortedChargeback

Estado do pagamento. Authorized ainda não foi capturado; PaymentConfirmed é pago.

boleto_urlstring

Só boleto: PDF.

boleto_barcodestring

Só boleto: código de barras.

authorization_codestring

Só cartão: código de autorização da operadora.

proof_of_salestring

Só cartão: NSU.

amountinteger

Valor, em centavos.

Erros

Status	Quando	Corpo de exemplo
400	Corpo inválido ou `payment_type` diferente de `CreditCard`/`Boleto`.	`{"error":"invalid payment_type: must be 'CreditCard' or 'Boleto'"}`
403	O módulo `braspag` está desligado nesta loja.	`{"error":"module_disabled","module":"braspag"}`
422	A Braspag recusou ou houve erro de processamento. O motivo detalhado não é devolvido.	`{"error":"payment processing failed"}`

Consultar pagamento Braspag

Consulta a Braspag e devolve o estado atual do pagamento. Use o payment_id recebido na criação.

GET/api/v1/storefront/braspag/payments/{paymentId}Pública

Estado atual de um pagamento na Braspag

Parâmetros de caminho

paymentIdstringobrigatório

GUID do pagamento (payment_id).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/braspag/payments/b1c2d3e4-f5a6-4b7c-8d9e-0a1b2c3d4e5f"

Resposta

200Pagamento

json

{
  "payment_id": "b1c2d3e4-f5a6-4b7c-8d9e-0a1b2c3d4e5f",
  "status": "PaymentConfirmed",
  "authorization_code": "123456",
  "proof_of_sale": "7654321",
  "amount": 22500
}

Campos da resposta

(corpo)object

Os mesmos campos de Criar pagamento Braspag.

Erros

Status	Quando	Corpo de exemplo
403	O módulo `braspag` está desligado nesta loja.	`{"error":"module_disabled","module":"braspag"}`
500	Qualquer falha na consulta, inclusive id desconhecido. O detalhe não é devolvido.	`{"error":"failed to retrieve payment status"}`

Veja também

API atual/Referência completa/Gateways de pagamento

Braspag

Cobra por cartão tokenizado ou boleto na Braspag e consulta o pagamento.

Duas rotas públicas para lojas que usam a Braspag como gateway. Ambas exigem o módulo braspag; sem ele respondem 403 module_disabled.

Criar pagamento Braspag

POST/api/v1/storefront/braspag/paymentsPública

Cobra um pedido por cartão (token) ou boleto na Braspag

Corpo da requisição

payment_typestringobrigatório

CreditCardBoleto

Tipo de pagamento, com essa grafia exata.

order_iduuidobrigatório

Pedido a cobrar.

amountinteger

Centavos. O total do pedido prevalece.

customer_namestringobrigatório

Nome do pagador.

customer_cpfstringobrigatório

CPF do pagador.

payment_tokenstring

CreditCard: token do cartão da Silent Order Post.

brandstring

CreditCard: bandeira (Visa, Master...).

installmentsintegerpadrão: 1

CreditCard: parcelas, de 1 a 12. Valores fora da faixa são ajustados ao limite mais próximo.

auto_capturebooleanpadrão: true

CreditCard: captura logo após autorizar. Envie false para só autorizar.

due_datestring

Boleto: vencimento em YYYY-MM-DD. Padrão: 3 dias a partir de hoje.

instructionsstring

Boleto: texto impresso no boleto. Padrão: Não receber após o vencimento.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/storefront/braspag/payments" \
  -H "Content-Type: application/json" \
  -d '{
    "payment_type": "Boleto",
    "order_id": "3f73310d-bfdd-4713-a664-305c08eda58b",
    "customer_name": "Maria Souza",
    "customer_cpf": "12345678909",
    "due_date": "2026-10-14",
    "instructions": "Não aceitar após o vencimento"
  }'

Resposta

201Pagamento criado

json

{
  "payment_id": "b1c2d3e4-f5a6-4b7c-8d9e-0a1b2c3d4e5f",
  "status": "Pending",
  "amount": 22500,
  "boleto_url": "https://boleto.braspag.com.br/xxxx",
  "boleto_barcode": "34191790010104351004791020150008899990000022500"
}

Campos da resposta

payment_idstring

GUID do pagamento na Braspag. É a chave para consultar.

statusstring

NotFinishedAuthorizedPaymentConfirmedDeniedVoidedRefundedPendingAbortedChargeback

Estado do pagamento. Authorized ainda não foi capturado; PaymentConfirmed é pago.

boleto_urlstring

Só boleto: PDF.

boleto_barcodestring

Só boleto: código de barras.

authorization_codestring

Só cartão: código de autorização da operadora.

proof_of_salestring

Só cartão: NSU.

amountinteger

Valor, em centavos.

Erros

Status	Quando	Corpo de exemplo
400	Corpo inválido ou `payment_type` diferente de `CreditCard`/`Boleto`.	`{"error":"invalid payment_type: must be 'CreditCard' or 'Boleto'"}`
403	O módulo `braspag` está desligado nesta loja.	`{"error":"module_disabled","module":"braspag"}`
422	A Braspag recusou ou houve erro de processamento. O motivo detalhado não é devolvido.	`{"error":"payment processing failed"}`

Consultar pagamento Braspag

Consulta a Braspag e devolve o estado atual do pagamento. Use o payment_id recebido na criação.

GET/api/v1/storefront/braspag/payments/{paymentId}Pública

Estado atual de um pagamento na Braspag

Parâmetros de caminho

paymentIdstringobrigatório

GUID do pagamento (payment_id).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/braspag/payments/b1c2d3e4-f5a6-4b7c-8d9e-0a1b2c3d4e5f"

Resposta

200Pagamento

json

{
  "payment_id": "b1c2d3e4-f5a6-4b7c-8d9e-0a1b2c3d4e5f",
  "status": "PaymentConfirmed",
  "authorization_code": "123456",
  "proof_of_sale": "7654321",
  "amount": 22500
}

Campos da resposta

(corpo)object

Os mesmos campos de Criar pagamento Braspag.

Erros

Status	Quando	Corpo de exemplo
403	O módulo `braspag` está desligado nesta loja.	`{"error":"module_disabled","module":"braspag"}`
500	Qualquer falha na consulta, inclusive id desconhecido. O detalhe não é devolvido.	`{"error":"failed to retrieve payment status"}`