Capturar Fatura para Boleto

POST

http://{{app_url}}/api/v1/invoices/capture/8bb4823a-f3c0-423b-ad15-59a024fa2c0c

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Bodyapplication/json

Exemplo

{
    "method": "boleto"
}

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'http://{{app_url}}/api/v1/invoices/capture/8bb4823a-f3c0-423b-ad15-59a024fa2c0c' \
--header 'Content-Type: application/json' \
--data-raw '{
    "method": "boleto"
}'

Respostas

🟢200Capturar Fatura para Boleto

application/json

Body

Exemplo

{
    "id": "8bb4823a-f3c0-423b-ad15-59a024fa2c0c",
    "ref": "8",
    "description": null,
    "status": "processing",
    "subtotal_amount": "100,00",
    "total_amount": "100,00",
    "tax_amount": null,
    "discount_amount": null,
    "link_token": "dCm4ABF1Vz7Xzv69jwaqnTb8cuQxhU",
    "link": "http://localhost:5180/hapo-code-ltda./public/fatura/dCm4ABF1Vz7Xzv69jwaqnTb8cuQxhU",
    "customer": {
        "id": "da55e5ed-c073-4dce-b649-14e4fe382a11",
        "name": "João da Silva",
        "email": "joao@testeste.com.br",
        "description": null,
        "cellphone": "11999999999",
        "cpfcnpj": "07120188917",
        "address": {
            "street": "Rua Reverendo Paulo Hecke",
            "number": "123",
            "complement": "Sala 1",
            "neighborhood": "Ahú",
            "city": "Curitiba",
            "state": "PR",
            "zip_code": "82200-300"
        }
    },
    "items": [
        {
            "id": "53b02835-b954-4bb7-a506-a64b76914a75",
            "product": {
                "id": "8c214358-46c3-4d90-991e-e12708deb114",
                "name": "Produto redondo",
                "description": "Desc",
                "price": "50,00"
            },
            "quantity": 2,
            "total": "100,00"
        }
    ],
    "payment": {
        "id": "a3ae792f-4645-4694-aab3-c67f117da90e",
        "status": "processing",
        "method": "boleto",
        "interest_amount": "0",
        "fee_amount": "400",
        "discount_amount": "0",
        "total_amount": "10000",
        "transaction": {
            "boleto_due_date": null,
            "boleto_barcode": null,
            "boleto_barcode_inline": "21390001171200003950800015003072193330001000000",
            "boleto_barcode_image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAVkAAAA8AQMAAAD2clvFAAAABlBMVEX///8AAABVwtN+AAAAAXRSTlMAQObYZgAAAAlwSFlzAAAOxAAADsQBlSsOGwAAAE9JREFUSIljWJVrFLbl1Gad1ao5W2Zt1jRbNmvaqc2auaaTJmdt81ytFnVmFZCnbbTm1GZdBoZRxaOKRxWPKh5VPKp4VPGo4lHFo4qppxgAr2Pk+apsrbgAAAAASUVORK5CYII="
        },
        "next_withdraw_available": "24/04/2023",
        "withdraw_agenda": null,
        "paid_at": null
    },
    "payable_with": {
        "pix": true,
        "boleto": true,
        "credit_card": true,
        "credit_card_with_interest": true
    },
    "shipping": null,
    "due_date": "27/04/2023",
    "paid_at": null,
    "notification_url": null,
    "created_at": "24/04/2023",
    "notifications": [
        {
            "title": "Nova fatura criada",
            "message": "Fatura com id: 8bb4823a-f3c0-423b-ad15-59a024fa2c0c criada com sucesso.",
            "type": "success",
            "created_at": "24/04/2023 15:48",
            "meta": []
        }
    ]
}

Modificado em 2025-06-17 19:24:53

Página anterior

Criar Fatura com Captura

Próxima página

Capturar Fatura para Pix