The events are structured and transmitted to the partner in JSON format. The following are the details of the fields sent, categorized by transaction type.
JSON PIX CASH IN EXAMPLE
{
"type": "QR_CODE_COPY_AND_PASTE_CREATED",
"data": {
"amount": 10,
"amount_chargeback": 0,
"base_64_image": null,
"base_64_image_url": "https://api-v3.saq.digital/v2/finance/image/qrcode/978e3d40******8b558f4.png",
"account_number": "00001",
"agency_number": "0001",
"debtor_document": "0******32",
"debtor_name": "Fulano de tal",
"due_date": null,
"expiration_date": "2024-01-01 00:00:00.000000+00:00",
"fee": 0,
"fine": null,
"fine_date": null,
"pix_copy_and_paste": "00020101021226880014br.gov.bcb.pix2566qrcodes.saq.digital/v2/qr/cob/******SAQ INSTITUICAO DE PAGAME6009SAO PAULO62070503***63040ED3",
"qr_code_id": 1,
"status": "NEW",
"tag": "NONE",
"tx_id": "978e3d40d3******e88b558f4",
"type_document": "CPF",
"type_fine": "NONE",
"worked": true
}
}
Field Type Description type String QR_CODE_COPY_AND_PASTE_CREATED - Payment generated, awaiting payment by the customer amount Decimal Returns the amount amount_chargeback Decimal If a refund occurs, this field will be filled with the refunded amount. base_64_image String Returns the generated QRCode image in base64 format (This field will be deprecated) base_64_image_url String Returns the link with the generated QRCode image account_number String Return the paye'rs document agency_number String Return the payer'rs agency debtor_document String Returns the Payer's document debtor_name String Returns the Payer's name due_date Datetime Returns the due date expiration_date Datetime Returns the expiration date fee Decimal Returns the fee that will be charged to the customer (if applicable) fine Decimal Returns the fine value fine_date Datetime Returns the fine date pix_copy_and_paste String This field returns the generated copy and paste code that the customer can pay directly through their bank qr_code_id Decimal Unique payment identifier generated. status String NEW - Payment generated, awaiting payment by the customer tag String Returns the tag (if applicable) tx_id String Unique payment identifier generated. type_document String Returns the Payer's type document type_fine String Returns the fine type worked Boolean Returns true or false confirming whether it was successful or not.
JSON PIX CASH IN EXAMPLE
{
"type": "QR_CODE_COPY_AND_PASTE_PAID",
"data": {
"amount": 100,
"amount_chargeback": 0,
"base_64_image": null,
"base_64_image_url": "https://api-v3.saq.digital/v2/finance/image/qrcode/431c561f79******ac7bc.png",
"account_number": "0001",
"agency_number": "0001",
"debtor_document": "75******20",
"debtor_institution": "BANK",
"debtor_institution_number": "000001",
"debtor_name": "Fulano de tal",
"due_date": null,
"end_to_end": "E18236120******02eb560ffa",
"expiration_date": "2024-01-01 12:00:00.000000+00:00",
"fee": 0,
"fine": null,
"fine_date": null,
"payment_date": "2024-01-01 12:00:00.000001+00:00",
"pix_copy_and_paste": "00020101021226880014br.gov.bcb.pix2566qrcodes.saq.digital/v2/qr/cob/******SAQ INSTITUICAO DE PAGAME6009SAO PAULO62070503***63040ED3",
"qr_code_id": 1,
"status": "PAID",
"tag": "NONE",
"tx_id": "431c561f7******d8cac7bc",
"type_document": "CPF",
"type_fine": "NONE",
"worked": true
}
}
type Type Description type String QR_CODE_COPY_AND_PASTE_PAID - Payment paid for custumer amount Decimal Returns the amount amount_chargeback Decimal If a refund occurs, this field will be filled with the refunded amount. base_64_image String Returns the generated QRCode image in base64 format (This field will be deprecated) base_64_image_url String Returns the link with the generated QRCode image account_number String Return the paye'rs document agency_number String Return the payer'rs agency debtor_document String Returns the Payer's document debtor_name String Returns the Payer's name due_date Datetime Returns the due date expiration_date Datetime Returns the expiration date fee Decimal Returns the fee that will be charged to the customer (if applicable) fine Decimal Returns the fine value fine_date Datetime Returns the fine date pix_copy_and_paste String This field returns the generated copy and paste code that the customer can pay directly through their bank qr_code_id Decimal Unique payment identifier generated. status String NEW - Payment generated, awaiting payment by the customer tag String Returns the tag (if applicable) tx_id String Unique payment identifier generated. type_document String Returns the Payer's type document type_fine String Returns the fine type worked Boolean Returns true or false confirming whether it was successful or not.
JSON PIX CASH IN EXAMPLE
{
"type": "QR_CODE_COPY_AND_PASTE_REFUNDED",
"data": {
"amount": 100,
"amount_chargeback": 100,
"chargeback_id": 1,
"debtor_document": "58******87",
"account_number": "0001",
"agency_number": "0001",
"debtor_name": "ROSA MARIA DA SILVA",
"end_to_end": "D35535240******MG3VDK2N",
"fee": 0,
"fine": null,
"fine_date": null,
"origin_chargeback_id": 1,
"origin_end_to_end": "E00360305******2c56b47a3c6",
"tag": "description",
"tx_id": "05b85cd026******631e62f4",
"status": "CHARGEBACK",
"type_document": "CPF",
"type_fine": "NONE",
"worked": true
}
}
Field Type Description type String QR_CODE_COPY_AND_PASTE_REFUNDED - Payment successfully refunded amount Decimal Returns the amount amount_chargeback Decimal If a refund occurs, this field will be filled with the refunded amount. chargeback_id Decimal Unique chargeback identifier generated. debtor_document String Returns the Payer's document account_number String Return the paye'rs document agency_number String Return the payer'rs agency debtor_name String Returns the Payer's name end_to_end String Payment identifier. fee Decimal Returns the fee that will be charged to thE customer (if applicable) fine Decimal Returns the fine value fine_date Datetime Returns the fine date origin_chargeback_id String Unique identifier for original transaction origin_end_to_end String Unique payment identifier original transaction generated. tag String Returns the tag (if applicable) tx_id String Unique identifier transaction generated. status String CHARGEBACK - Payment refunded all value type_document String Returns the Payer's type document type_fine String Returns the fine type worked Boolean Returns true or false confirming whether it was successful or not.
JSON PIX CASH IN EXAMPLE
{
"type": "QR_CODE_COPY_AND_PASTE_REFUNDED_ERROR",
"data": {
"amount": 0.01,
"amount_chargeback": 0.01,
"chargeback_id": 10,
"end_to_end": "D35535240******60PSEEHRSVDQ",
"account_number": "00001",
"agency_number": "0001",
"debtor_document": "12******11",
"debtor_name": "Fulado de tal",
"fee": 0,
"fine": null,
"fine_date": null,
"origin_chargeback_id": 1,
"origin_end_to_end": "E30306294******4500000000000",
"status": "CHARGEBACK",
"tag": "description",
"type_document": "CPF",
"type_fine": "NONE",
"worked": true
}
}
Field Description type QR_CODE_COPY_AND_PASTE_REFUNDED_ERROR - Error refunded payment amount Returns the amount amount_chargeback If a refund occurs, this field will be filled with the refunded amount. chargeback_id Unique chargeback identifier generated. end_to_end Payment identifier. account_number Return the paye'rs document agency_number Return the payer'rs agency debtor_document Returns the Payer's document debtor_name Returns the Payer's name fee Returns the fee that will be charged to the customer (if applicable) fine Returns the fine value fine_date Returns the fine date origin_chargeback_id Returns the QRCode ID origin payment. origin_end_to_end Returns the QRCode End To End origin payment status CHARGEBACK- Payment refunded sucessfully completed tag Returns the tag (if applicable) type_document Returns the Payer's type document type_fine Returns the fine type worked Returns true or false confirming whether it was successful or not.
JSON PIX CASH IN EXAMPLE
{
"type": "PIX_CASHIN_RECEIVED",
"data": {
"amount": 0.01,
"debtor_account": "0001",
"debtor_branch_identifier": "1",
"debtor_institution": "000001",
"debtor_legal_id": "12******11",
"debtor_name": "Fulano de tal",
"debtor_account_type": "CURRENT_ACCOUNT",
"end_to_end": "E3030629******422000020aeJxs",
"fee": 0,
"from_account": "000001",
"from_agency": "0001",
"from_account_key": "6efc7203-b4b9-4009-ced9-2d89951427ee",
"payment_date": "2024-01-01 12:00:00.000000+00:00",
"type_transfer": "key",
"worked": true
}
}
<th>
Type
</th>
<th>
Description
</th>
</tr>
<td>
String
</td>
<td>
PIX_CASHIN_RECEIVED - Payment received via bank-to-bank transfer
</td>
</tr>
<tr>
<td>
**amount**
</td>
<td>
Decimal
</td>
<td>
Returns the amount
</td>
</tr>
<tr>
<td>
**debtor_account**
</td>
<td>
String
</td>
<td>
Return the paye'rs account number
</td>
</tr>
<tr>
<td>
**debtor_branch_identifier**
</td>
<td>
String
</td>
<td>
Return the paye'rs account branch
</td>
</tr>
<tr>
<td>
**debtor_institution**
</td>
<td>
String
</td>
<td>
Return the payer'rs bank institution ISPB number
</td>
</tr>
<tr>
<td>
**debtor_legal_id**
</td>
<td>
String
</td>
<td>
Returns the Payer's document
</td>
</tr>
<tr>
<td>
**debtor_name**
</td>
<td>
String
</td>
<td>
Returns the Payer's name
</td>
</tr>
<tr>
<td>
**debtor_account_type**
</td>
<td>
String
</td>
<td>
Return the paye'rs account type
may be one of the following:
* *CURRENT_ACCOUNT** - Standard current/checking account
* *SALARY_ACCOUNT** - Account designated for salary payments
* *SAVINGS_ACCOUNT** - Savings account
* *PAYMENT_ACCOUNT **- Payment account (e.g., digital wallet)
</td>
</tr>
<tr>
<td>
**end_to_end**
</td>
<td>
String
</td>
<td>
Returns the e2e (End-to-End), a unique identifier used in financial transactions to facilitate the identification and tracking of operations.
</td>
</tr>
<tr>
<td>
**fee**
</td>
<td>
Decimal
</td>
<td>
Returns the fee that will be charged to the SaQ.Digital customer (if applicable)
</td>
</tr>
<tr>
<td>
**from_account**
</td>
<td>
String
</td>
<td>
Returns the account number where the transfer was received
</td>
</tr>
<tr>
<td>
**from_agency**
</td>
<td>
String
</td>
<td>
Returns the agency number where the transfer was received
</td>
</tr>
<tr>
<td>
**from_account_key**
</td>
<td>
String
</td>
<td>
Returns the Pix key of the account that received the transfer. If the transfer was made manually (without a Pix key), this field will be empty
</td>
</tr>
<tr>
<td>
**type_transfer**
</td>
<td>
String
</td>
<td>
Indicates whether the transfer was received via Pix key or Manual transfer
* *key** - Received payment from pix key account
* *manual** - Received payment from account number account
</td>
</tr>
<tr>
<td>
**worked**
</td>
<td>
Boolean
</td>
<td>
Shows the status of the received transfer
</td>
</tr>
JSON PIX CASH OUT EXAMPLE
{
"type": "PIX_CASHOUT_CREATED",
"data": {
"amount": 100,
"code_transaction": "01000000-da69-7a52-f189-08ddf4bc330b",
"fee": 0,
"from_accout": "463339",
"key": "05967095101",
"status": "NEW",
"tag": "2509161025357691309986",
"transaction_id": 961588700187,
"worked": true
}
}
Field Type Description type String PIX_CASHOUT_CREATED - Payment generated or awaiting approval amount Decimal Returns the amount code_transaction String Returns a unique identifier (This field will be deprecated) fee Decimal Returns the fee that will be charged to the customer (if applicable) from_accout String Returns information about the originating account. key String Returns the Pix key. tag String Returns the tag (if applicable) transaction_id String A unique payment identifier has been generated. This value never repeats and allows querying endpoints to check the status of a Pix Cash Out worked Boolean Returns true or false confirming whether it was successful or not.
JSON PIX CASH OUT EXAMPLE
{
"type": "PIX_CASHOUT_SUCCESS",
"data": {
"amount": 100,
"transaction_id": 1,
"end_to_end": "E355352402****840W36G858B7",
"fee": 0,
"from_accout": "463339",
"key": "05967095101",
"payment_date": "2024-01-01 12:00:00.000000+00:00",
"recipient_account_id": "0000001",
"recipient_branch_identifier": "1",
"recipient_instution": "000000",
"recipient_legal_id": "05******01",
"recipient_name": "Fulano de tal",
"status": "SUCCESS",
"tag": "description",
"worked": true
}
}
Field Type Description type String PIX_CASHOUT_SUCCESS - Payment successfully completed amount Decimal Returns the amount code_transaction String Returns a unique identifier (EndtoEnd) end_to_end String End to end transaction error String Descriptor error transaction fee Decimal Returns the fee that will be charged to the customer (if applicable) from_accout String Returns information about the originating account. key String Returns the Pix key. recipient_account_id String Destiny account number recipient_branch_identifier String Destiny account branch recipient_instution String ISPB institution to received transfer recipient_legal_id String Document user recipient_name String Recipient name status String Returns the status tag String Returns the tag (if applicable) transaction_id Decimal A unique payment identifier has been generated. This value never repeats and allows querying endpoints to check the status of a Pix Cash Out worked Boolean Returns true or false confirming whether it was successful or not.
JSON PIX CASH OUT EXAMPLE
{
"type": "PIX_CASHOUT_ERROR",
"data": {
"amount": 100,
"code_transaction": null,
"end_to_end": null,
"error": "PIX key not found",
"fee": 0,
"from_accout": "00001",
"key": "+55********75",
"recipient_account_id": null,
"recipient_branch_identifier": null,
"recipient_instution": null,
"recipient_legal_id": null,
"recipient_name": null,
"status": "ERROR",
"tag": "description",
"transaction_id": 1,
"worked": false
}
}
Field Description type PIX_CASHOUT_ERROR - Payment not completed due to errors in the provided amount Returns the amount code_transaction Returns a unique identifier (This field will be deprecated) end_to_end End to end transaction error Descriptor error transaction fee Returns the fee that will be charged to the customer (if applicable) from_accout Returns information about the originating account. key Returns the Pix key. recipient_account_id Destiny account number recipient_branch_identifier Destiny account branch recipient_instution ISPB institution to received transfer recipient_legal_id Document user recipient_name Recipient name status Returns the status tag Returns the tag (if applicable) transaction_id A unique payment identifier has been generated. This value never repeats and allows querying endpoints to check the status of a Pix Cash Out worked Returns true or false confirming whether it was successful or not.
JSON PIX CASH OUT EXAMPLE
{
"type": "PIX_CASHOUT_REFUND",
"data": {
"amount": 0.01,
"transaction_id": 1,
"end_to_end": "D30306294******60000002Pjdp",
"fee": 0,
"from_accout": "900002",
"key": "14******47",
"origin_end_to_end": "E35535240******GRGBGLAIRDN",
"origin_transaction_id": 1,
"recipient_account_id": "8044331",
"recipient_branch_identifier": "20",
"recipient_instution": "30306294",
"recipient_legal_id": "14******47",
"recipient_name": "Fulano de tal",
"status": "REFUNDED",
"tag": null,
"worked": true
}
}
Field Type Description type String PIX_CASHOUT_REFUND - Payments not accepted by the recipient that are returned to the source account statement amount Decimal Returns the amount transaction_id Decimal A unique payment identifier has been generated. This value never repeats and allows querying endpoints to check the status of a Pix Cash Out end_to_end String Payment identifier. fee Decimal Returns the fee that will be charged to the customer (if applicable) from_accout String Returns information about the originating account. key String Returns the Pix key. origin_end_to_end String Returns the origin End To End transaction origin_transaction_id String Returns the ID transactions origin. recipient_account_id String Returns the account number recipient_branch_identifier String Returns agency number recipient_instution String Returns account ISPB institution recipient_legal_id String Returns account document recipient_name String Return account name status String Returns the status tag String Returns the tag (if applicable) worker Boolean Status refunded
JSON PIX CASH OUT EXAMPLE
{
"type": "PIX_CASHOUT_CANCELED",
"data": {
"amount": 0.01,
"transaction_id": 1,
"end_to_end": null,
"fee": 0,
"from_accout": "900002",
"key": "14******47",
"recipient_account_id": "8044331",
"recipient_branch_identifier": "20",
"recipient_instution": "30306294",
"recipient_legal_id": "14******47",
"recipient_name": "Fulano de tal",
"status": "CANCELLED",
"cancel_description": "Insufficient balance",
"tag": null,
"worked": true
}
}
Field Type Description type String PIX_CASHOUT_CANCELED - Payments canceled amount Decimal Returns the amount transaction_id Decimal A unique payment identifier has been generated. This value never repeats and allows querying endpoints to check the status of a Pix Cash Out end_to_end String Payment identifier. fee Decimal Returns the fee that will be charged to the customer (if applicable) from_accout String Returns information about the originating account. key String Returns the Pix key. recipient_account_id String Returns the account number recipient_branch_identifier String Returns agency number recipient_instution String Returns account ISPB institution recipient_legal_id String Returns account document recipient_name String Return account name status String Returns the status cancel_description String Returns the cancellation description of the transaction tag String Returns the tag (if applicable) worker Boolean Status refunded
