Meio de Pagamento: Boleto
This endpoint creates a new charge with the provided data.
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 //sandbox-api.pagou.com.br//v1/charges HTTP/1.1
Host: https
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
This endpoint return a charge.
Path parameters
chargeIDstringRequired
Charge ID
Responses
200
OK
application/json
Responsestring
400
Bad Request
application/json
401
Unauthorized
application/json
404
Not Found
application/json
500
Internal Server Error
application/json
get
GET //sandbox-api.pagou.com.br//v1/charges/{chargeID} HTTP/1.1
Host: https
Accept: */*
text
This endpoint requests a cancellation for an active charge with the provided data.
Path parameters
chargeIDstringRequired
Charge ID
Responses
204
No Content
400
Bad Request
application/json
401
Unauthorized
application/json
500
Internal Server Error
application/json
delete
DELETE //sandbox-api.pagou.com.br//v1/charges/{chargeID} HTTP/1.1
Host: https
Accept: */*
No content
Last updated