Meio de Pagamento: Boleto

Create a Charge

This endpoint creates a new charge with the provided data.

post

/v1/charges

Body

amountnumber · min: 5required

customer_codestring

descriptionstringrequired

discountobject

due_datestringrequired

finenumber · min: 0.1 · max: 100required

grace_periodinteger · max: 30required

interestnumber · min: 0.1 · max: 100required

metadataobject[]

notification_urlstring

payerobjectrequired

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://https://sandbox-api.pagou.com.br//v1/charges' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
    }
  }'

201

400

401

500

201

text

Created

Get a Charge

This endpoint return a charge.

get

/v1/charges/{chargeID}

Path parameters

chargeIDanyrequired

Charge ID

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://https://sandbox-api.pagou.com.br//v1/charges/{chargeID}'

200

400

401

404

500

200

text

OK

Cancel a Charge

This endpoint requests a cancellation for an active charge with the provided data.

delete

/v1/charges/{chargeID}

Path parameters

chargeIDanyrequired

Charge ID

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'http://https://sandbox-api.pagou.com.br//v1/charges/{chargeID}'

204

400

401

500

204

No body

No Content