[GET] /payments/:id

Busca os detalhes de uma cobrança Bolepix

Endpoint de produçãoCopied!

Método GET

https://bank-slip-api.firebanking.com.br/payments/:id

RequisiçãoCopied!

Headers

Campo	Valor	Tipo	Descrição
Content-Type	application/json	string	Define o conteúdo como JSON
apiKey	123	string	Sua chave de API

Parâmetros da rota

Campo	Obrigatório	Descrição
id	Sim	ID retornado no momento da criação do boleto ou external id enviado no body da criação do boleto

cURL

curl --request GET \
  --url 'https://bank-slip-api.firebanking.com.br/payments/<id>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <sua-chave-api>'

Exemplo de respostaCopied!

HTTP Status 200 - Sucesso

{
    "amount": "850.75",
    "description": "Pagamento referente à fatura de serviços prestados no mês de março",
    "dueDate": "2025-04-10",
    "externalId": "EXT987654321",
    "id": "a7b8c9d0-1234-5678-abcd-efghijklmnop",
    "paymentDate": "2023-08-15T09:30:00.000Z",
    "status": "PAID",
    "barcode": "34198103400001850700125005310145678965430000",
    "slipLine": "34191090090518507634567890000003810290000850750",
    "issuingBank": "bradesco",
    "pixCode": "00020101021226980014br.gov.bcb.pix2576qrcode-h.pix.celcoin.com.br/pixqrcode/v2/cobv/9e30b4fcb8ef234b1c5a7e9f6dff62214000053039865802BR5924Servicos Exemplares Ltda6007SaoPaulo62070503***6304DEFG",
    "transactions": [
        {
            "id": "b8d7e6a5-1234-5678-abcd-9876543210fe",
            "status": "PENDING"
        },
        {
            "id": "d4f5e6a7-89b0-1234-cdef-1234567890ab",
            "status": "WAITING_PAYMENT"
        },
        {
            "id": "a1b2c3d4-5678-1234-e567-8901234567cd",
            "status": "PAID"
        }
    ],
    "instructions": {
        "fine": {
            "type": "PERCENTAGE",
            "value": "0.5"
        },
        "interest": {
            "type": "PERCENTAGE",
            "value": "12"
        }
    },
    "pdfUrl": "https://s3.us-east-1.amazonaws.com/dev.documents.pagamentos/boletos/abcdefg1234567890/abcdefg1234567890abcdefg.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAZJHA22DGETYU5IUT%2F20250412%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250412T121530Z&X-Amz-Expires=604800&X-Amz-Signature=6a7b543fb6f49f0f9b5b216e2a1238b4faed3485291f625957c22369de5b59f&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject",
    "payer": {
        "city": "SAO PAULO",
        "name": "JULIANO PEREIRA SILVA",
        "document": "12345678901",
        "neighborhood": "PONTE GRANDE",
        "number": "2500",
        "postalCode": "03367010",
        "publicArea": "AV. RIO DAS PEDRAS",
        "state": "SP"
    }
}

HTTP Status 404 - Not found

{
    "message": "Payment with id 3f73ad66-04cb-4c2d-9520-e41e41c576cd not found",
    "error": "Not Found",
    "statusCode": 404
}

HTTP Status 400 - Bad request

{
    "message": [
        "id must be a UUID"
    ],
    "error": "Bad Request",
    "statusCode": 400
}