Meio de Pagamento: Boleto

Create a Charge

This endpoint creates a new charge with the provided data.

POST//https://sandbox-api.pagou.com.br/v1/charges

Body

application/json

Charge data

amount*number

customer_codestring

description*string

discountmodels.Discount (object)

due_date*string

fine*number

grace_period*integer

interest*number

metadataarray of models.ChargeMetadata (object)

notification_urlstring

payer*models.ChargePayer (object)

Response

201400401500

Created

Body

application/json

string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('//https://sandbox-api.pagou.com.br/v1/charges', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "amount": 0,
      "description": "text",
      "due_date": "text",
      "fine": 0,
      "grace_period": 0,
      "interest": 0,
      "payer": {
        "city": "text",
        "document": "text",
        "name": "text",
        "neighborhood": "text",
        "number": "text",
        "state": "text",
        "street": "text",
        "zip": "text"
      }
    }),
});
const data = await response.json();

Response

201400401500

text

Get a Charge

This endpoint return a charge.

GET//https://sandbox-api.pagou.com.br/v1/charges/{chargeID}

Path parameters

chargeID*string

Charge ID

Response

200400401404500

OK

Body

application/json

string

Request

JavaScriptCurlPythonHTTP

const response = await fetch('//https://sandbox-api.pagou.com.br/v1/charges/{chargeID}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401404500

text

Cancel a Charge

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

DELETE//https://sandbox-api.pagou.com.br/v1/charges/{chargeID}

Path parameters

chargeID*string

Charge ID

Response

204400401500

No Content

Request

JavaScriptCurlPythonHTTP

const response = await fetch('//https://sandbox-api.pagou.com.br/v1/charges/{chargeID}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401500

{
  "error": "text",
  "errors": [
    "text"
  ]
}