转账凭证

Request

ENDPOINT

/transaction_receipt/TRANSACTION_KEY

MÉTODO

GET

信息

此请求的响应将返回所查询交易的相关数据。若参数 PDF 为 true，则 pdf_encoded_string 字段将以 base-64 编码的 PDF 字符串形式提供。

Request Path Params

字段	类型	描述	字符数
`transaction_key` *	uuidv4	交易唯一识别密钥。	36

Request Query String Params

字段	类型	描述	字符数
`pdf` *	boolean	定义响应是否生成 PDF 的布尔值。	-

Response

成功响应

STATUS

200

Response Body: Boleto 支付凭证

{
    "bank_slip": {
        "beneficiary": {
            "document_number": "03782617037",
            "document_number_formatted": "037.826.170-37",
            "name": "Beatriz Couto de Carvalho"
        },
        "digitable_line": "32992269485000000000554007797902798030027500000",
        "expiration_date": "2024-08-09",
        "expiration_date_formatted": "09/08/2024",
        "financial_institution_compe_number": "329",
        "financial_institution_name": "QI SOCIEDADE DE CRÉDITO DIRETO S.A.",
        "payer": {
            "document_number": "32402502000135",
            "document_number_formatted": "32.402.502/0001-35",
            "name": "QI SCD S.A."
        },
        "payment_date": "2024-08-06",
        "payment_date_formatted": "06/08/2024",
        "payment_key": "ca944fbb-7f0f-42d7-b775-1014f5804155",
        "tax_collection_info": null
    },
    "origin_key": "ca944fbb-7f0f-42d7-b775-1014f5804155",
    "pdf_encoded_string": "<base64 encoded PDF string>"
}

Response Body: 代收税款发票凭证

{
    "tax_collection": {
        "beneficiary": {
            "document_number": "03782617037",
            "document_number_formatted": "037.826.170-37",
            "name": "Beatriz Couto de Carvalho"
        },
        "payment_date": "2024-08-06",
        "payment_date_formatted": "06/08/2024",
        "payment_key": "ca944fbb-7f0f-42d7-b775-1014f5804155"
    },
    "origin_key": "ca944fbb-7f0f-42d7-b775-1014f5804155",
    "pdf_encoded_string": "<base64 encoded PDF string>"
}

Response Body: TED 凭证

{
    "ted": {
        "payer": {
            "document_number": "32402502000135",
            "document_number_formatted": "32.402.502/0001-35",
            "name": "QI SCD S.A.",
            "account_branch": "0001",
            "account_number": "000002",
            "account_digit": "5"
        },
        "receiver": {
            "document_number": "12345678000195",
            "document_number_formatted": "12.345.678/0001-95",
            "name": "Empresa Destino",
            "account_branch": "0001",
            "account_number": "1234567",
            "account_digit": "8",
            "financial_institution_compe_number": "001",
            "financial_institution_name": "Banco do Brasil S.A."
        },
        "amount": 100.00,
        "amount_formatted": "R$ 100,00",
        "payment_date": "2024-08-06",
        "payment_date_formatted": "06/08/2024",
        "payment_key": "ca944fbb-7f0f-42d7-b775-1014f5804155"
    },
    "origin_key": "ca944fbb-7f0f-42d7-b775-1014f5804155",
    "pdf_encoded_string": "<base64 encoded PDF string>"
}

Response Body: PIX 凭证

{
    "pix": {
        "payer": {
            "document_number": "32402502000135",
            "document_number_formatted": "32.402.502/0001-35",
            "name": "QI SCD S.A."
        },
        "receiver": {
            "document_number": "12345678000195",
            "document_number_formatted": "12.345.678/0001-95",
            "name": "Empresa Destino"
        },
        "amount": 100.00,
        "amount_formatted": "R$ 100,00",
        "payment_date": "2024-08-06",
        "payment_date_formatted": "06/08/2024",
        "payment_key": "ca944fbb-7f0f-42d7-b775-1014f5804155",
        "end_to_end_id": "E32402502202408061500Xl7fS6mvuFW"
    },
    "origin_key": "ca944fbb-7f0f-42d7-b775-1014f5804155",
    "pdf_encoded_string": "<base64 encoded PDF string>"
}

Response Body: 银行卡消费凭证

{
    "card_purchase": {
        "card_holder": {
            "document_number": "32402502000135",
            "document_number_formatted": "32.402.502/0001-35",
            "name": "QI SCD S.A."
        },
        "merchant": {
            "name": "Nome do Estabelecimento",
            "mcc": "0000"
        },
        "amount": 17.00,
        "amount_formatted": "R$ 17,00",
        "transaction_date": "2024-08-06",
        "transaction_date_formatted": "06/08/2024",
        "transaction_key": "b71ea9a3-e012-4761-bea6-e65c6bfc228f",
        "authorization_code": "U3UUUU"
    },
    "origin_key": "b71ea9a3-e012-4761-bea6-e65c6bfc228f",
    "pdf_encoded_string": "<base64 encoded PDF string>"
}

错误响应

STATUS

4XX

Response Body

{
    "title": "Título",
    "description": "Description in english",
    "translation": "Descrição em português",
    "code": "Código"
}

Request​

Request Path Params​

Request Query String Params​

Response​

成功响应​

错误响应​