PaymentBoleto POST
/payment-boleto
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| customer_name | string | Nome do cliente que está fazendo a compra |
YES |
| customer_email | string | Email do cliente que está fazendo a compra |
YES |
| customer_type | string | Tipo de pessoa: Utilize PF para Pessoa Física Utilize PJ para Pessoa Jurídica |
YES |
| customer_taxvat | string | Número do CPF ou CNPJ do cliente |
YES |
| customer_phone | string | Telefone do comprador |
YES |
| customer_address | object | Endereço do comprador |
YES |
| reference_id | string | Identificador do pedido na plataforma do vendedor |
YES |
| order_total | float | Valor total do pedido |
YES |
| order_items | object | Lista de itens/produtos da compra realizada |
YES |
| shipment | object | Informações da entrega do pedido |
NO |
| due_date | date | Data de vencimento do boleto: Formato YYYY-mm-dd. Caso não seja informado, utilizará as configurações setadas na conta do usuário |
YES |
| additional_information | string | Instruções adicionais exibidas no final do boleto |
NO |
| notification_url | string | URL para envio de notificação (Webhook) |
NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/json |
| Content-Type | application/json |
| Authorization | Bearer token |
Request Body
{
"customer_name":"João da Silva",
"customer_email":"[email protected]",
"customer_type":"PF",
"customer_taxvat":"000.000.001-91",
"customer_address":{
"postalcode":"17980-000",
"street":"Nome da Rua",
"number":"1122",
"complement":"CASA",
"district":"Centro",
"city":"Panorama",
"uf":"SP",
"country":"BR"
},
"customer_phone":"14991866161",
"reference_id":"10000001",
"order_total":"189.90",
"due_date":"2022-10-22",
"order_items":[
{
"id":"sku1",
"name":"Nome do primeito produto",
"qty":"10",
"unit_price":"100.00",
"total":"1000.00"
},
{
"id":"sku2",
"name":"Nome do primeito produto 2",
"qty":"2",
"unit_price":"180.00",
"total":"360.00"
}
],
"additional_information":"N\u00e3o receber ap\u00f3s 3 dias do vencimento",
"shipment":{
"shipment_price":"12.89",
"shipment_address":{
"postalcode":"17980-000",
"street":"Nome da Rua",
"number":"1122",
"complement":"CASA",
"district":"Centro",
"city":"Panorama",
"uf":"SP",
"country":"BR"
}
},
"notification_url":"http:\/\/www.url.com.br\/notification.php"
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Response Body
{
"id": "135",
"customer_phone": "14988889999",
"transaction_type": "boleto",
"reference_id": "10000001",
"status": "pending_payment",
"transaction_order_total": "189.90",
"transaction_fee": "2.49",
"transaction_amount": "187.41",
"address_postal_code": "17980-000",
"address_street": "Nome da Rua",
"address_number": "1122",
"address_complement": "CASA",
"address_district": "Centro",
"address_state": "SP",
"address_city": "Panorama",
"address_country": "BR",
"shipping_postal_code": "17980-000",
"shipping_street": "Nome da Rua",
"shipping_number": "1122",
"shipping_complement": "CASA",
"shipping_district": "Centro",
"shipping_state": "SP",
"shipping_city": "Panorama",
"shipping_country": "BR",
"shipping_amount": "12.89",
"transaction_history": [
{
"date": "2022-10-19 19:37:39",
"message_type": "thistory_default",
"history_message": "Compra efetuada"
}
],
"payment_data": {
"boleto_url": "https://www.boleto.com.br/boleto.pdf",
"boleto_expiration_date": "2022-10-24 23:59:59",
"EntryId": 260066983,
"DocumentNumber": 109952,
"boleto_barcode": "31234514800000189901090000187398072124681000",
"boleto_digitable_line": "34191.09008 00222.333333 00000.000000 0 00000000018990"
},
"has_split": "0",
"is_splited": "0",
"notification_url": "http://www.urlnotificacao.com.br",
"created_at": "2022-10-19 19:37:40",
"updated_at": "2022-10-19 19:37:43"
}