Documentação da API
  • Introdução
  • Credenciais de acesso
  • Integração com a API
    • Meio de Pagamento: Boleto
      • Criando um Boleto
      • Consultando um Boleto
      • Cancelando um Boleto
    • Meio de Pagamento: Pix
      • Criando um QRCode
      • Consultando um QRCode
      • Cancelando um QRCode
      • Estornando um QRCode
    • Consultando saldo
  • Specification
Powered by GitBook
On this page
  1. Integração com a API
  2. Meio de Pagamento: Boleto

Criando um Boleto

PreviousMeio de Pagamento: BoletoNextConsultando um Boleto

Last updated 8 days ago

Create a Charge

post

This endpoint creates a new charge with the provided data.

Authorizations
Header parameters
User-AgentanyOptional

Client Identifier

Body
amountnumber · min: 5Required
customer_codestringOptional
descriptionstringRequired
due_datestringRequired
finenumber · min: 0.1 · max: 100Required
grace_periodinteger · max: 30Required
interestnumber · min: 0.1 · max: 100Required
notification_urlstringOptional
Responses
201
Created
application/json
Responsestring
400
Bad Request
application/json
401
Unauthorized
application/json
500
Internal Server Error
application/json
post
POST /v1/charges HTTP/1.1
Host: sandbox-api.pagou.com.br
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 379

{
  "amount": 1,
  "customer_code": "text",
  "description": "text",
  "discount": {
    "amount": 1,
    "limit_date": "text",
    "type": "fixed"
  },
  "due_date": "text",
  "fine": 1,
  "grace_period": 1,
  "interest": 1,
  "metadata": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "notification_url": "text",
  "payer": {
    "city": "text",
    "document": "text",
    "name": "text",
    "neighborhood": "text",
    "number": "text",
    "state": "text",
    "street": "text",
    "zip": "text"
  }
}
text