SaQ.Digital events are structured and transmitted to the partner in JSON format. The following are the details of the fields sent, categorized by transaction type.
PIX CASH IN
{'type': 'QR_CODE_COPY_AND_PASTE_CREATED', 'data': {'amount': 36.8, 'amount_chargeback': 0, 'base_64_image': 'iVBORw0KGgoAAAANSUhEUgAAAhIAAAISAQAAAACxRhsSAAAE7ElEQVR4nO2dS27jRhCGvwoJaNkEfIAchbxBjjSYI+UG5FF0AAPkcgASlUU/JTueAUZmFOOvhU1RrQ9NoFCvrm6a87uy/PHbCBBDDDHEEEMMMcQQQ4zKsCQ9LMNhNm09ZgPAZmYTh8XhywA2bXn89OB5iCHG+9LHf+MMsL1gBICwAxy9ExxbDIywYuN69M7W7QDY4+Yhhhi/wtiSdfR5S0bV/Xpx4DAIO+7XHv8+pPHR+D5+HmKI8SsMm+jcfe3cpvDDWIbO3a99+Tb9+ex5iCFGK/3dZ4/OH2Cxzi0697D3LBPmbPc/eNA8xBDjI8lqFxzYwKDDY2jKYYxzvOeM68tex7XLA8/yLGJ8ecZiZjHBH1ewabu4TdvFYethvPbYBMRCwMQR0/3Hz0MMMd4Xv5e1c0Z3j0l/unJn9B0Ib8b7/CzPIsbXZUQ9jZfjCjG3n8OOz3T5C88f41UZIj0V4xxG0tNiLPPVjWL6mmoAxEjV3X2mkz0V42zGdnHGWH7qPFlWDoPt4mbDUaLXw1jMLOnzw+chhhjvSmNPk+oVPQ01ILi5N66dNyJ7KsanM0oelRx9vIqO3vccvYY9Rq8+A3lVFcWnYpzFaMv2ox8G4RUj/DAIq8M24Gw9aVU/rABHLLE+cB5iiPGhVHua3Lsnz55zey/3iEN8poYLsqdinMHIvvv2aqbzmu9DrlD5HEqJdZXfF+M0xk2dvxrLlfuqaTKquX6ai1jSUzHOYGQHvnZejWVKq2q+X6sBwW/VVnoqxhmM7LtDiUCjFa1flLJ/8PuYVX5fjJMYrZ4SUnxa1TF9XFMsENW2Saukp2Kcwrgxm/Ves1BKUscSECQJsqdinMYofSilS4rOmz6UMdf5sz31Mk75vhinM8IOpVnfJjq3Ccj9p5esyitlXLa2T/csYnxVRrMemhqkDqttfix/7pgNh1G29aV+6gfPQwwx/kUavx8lZEf/TswaF6qSdKpLiXEWo3Sa+O2SaU7/azNKVNFcv8pplfRUjDMYrRKmrtOudO7teG2kmusXa6c+aTFOZTTrpk05v/Tzp80nTV9fl9N/1fnFOJ2RDkDpYbyaMV4vbt9iMnVYyrJqMwo6D0WMcxlF2Tpn+csxgsMyYL4M3Q5h7228XtxSqv9qQI+zDeaPm4cYYnword+n83bn88rbzXw5Zm02n8jvi/HpjPt2k7o/L62bhrL5hFJnpV2Zkp6K8fmMku+3nSbxytc8ZA6lLaWmWqqfinEeo+mXaixr7ZdqfPxarOgK6usT40xGPqd3BRv/ftnjhv14c+tTCLAMGATHxqvhbADbS16uepZnEePrMppdUcmLl03PyXZ23nT2J2l3TcueivH5jJtzJlZyMl/uRan9/Oub30pPxfh8xv15fcT+U6A9r68smc7Q7uiTnopxJqN530k67KS0RcVe08NSgrXWe6VF9bmeRYwvzBibwj7YN99J75HIe6Bt2szyxz2+oefx8xBDjPel1k9z597eBqmt3GZUqvOL8Z8yOjcbwL/Hk83zjr6YVm1mdb9pimOf+FnE+CKMt68v2QyHAxvXAcb5MKDDl+G1Z1xfdlus2131UzFOZLQHmtWj+YuxrMf4pGXU0NavlO+LcRKjPZ+f2huVdTcOmSn7o5p76pcS4zSG+c/H/ESWZ3kWMcQQQwwxxBBDDDH+/4x/ABEm/nnBU6XVAAAAAElFTkSuQmCC', 'base_64_image_url': 'https://saq-api-files.s3-sa-east-1.amazonaws.com/media/5481da5d-b96b-46ae-999c-d5da2a3404a5.png', 'debtor_document': 'xxxxxxxxxxx', 'debtor_name': 'xxxxxx xxxxxx xxxxxx', 'due_date': '2024-05-20T14:45:45.269Z', 'expiration_date': '2024-05-20 14:45:46.269000', 'fee': 0.0, 'fine': 0, 'fine_date': '2024-05-20T14:45:46.269Z', 'pix_copy_and_paste': '00020101021226970014br.gov.bcb.pix2575qr-h.cornerpix.com.br/11581339/v2/cobv/9be93fde-5443-4c11-ba2e-b3a52db47caf5204000053039865802BR5914BMP MONEY PLUS6009SAO PAULO62070503***6304D95E', 'qr_code_id': xxxxxx, 'status': 'NEW', 'type_document': 'CPF', 'type_fine': 'NONE', 'worked': True}}
| Field | Description |
|---|---|
| type | QR_CODE_COPY_AND_PASTE_CREATED - Payment generated, awaiting payment by the customer QR_CODE_COPY_AND_PASTE_PAID - Payment successfully completed QR_CODE_COPY_AND_PASTE_REFUNDED - Payment successfully refunded |
| amount | Returns the amount |
| amount_chargeback | If a refund occurs, this field will be filled with the refunded amount. |
| base_64_image | Returns the generated QRCode image in base64 format |
| base_64_image_url | Returns the link with the generated QRCode image |
| debtor_document | Returns the Payer's document |
| debtor_name | Returns the Payer's name |
| due_date | Returns the due date |
| expiration_date | Returns the expiration date |
| fee | Returns the fee that will be charged to the SaQ.Digital customer (if applicable) |
| fine | Returns the fine value |
| fine_date | Returns the fine date |
| pix_copy_and_paste | This field returns the generated copy and paste code that the customer can pay directly through their bank |
| qr_code_id | Unique payment identifier generated. |
| status | NEW - Payment generated, awaiting payment by the customer PAID - Payment successfully completed CANCELED - Payment canceled / expired |
| 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. |
CHARGEBACK/MED
{'type': 'PIX_MED_RECEIVE', 'data': {'pix_med_id': 2, 'name': 'Matheus xxxxxx Falcao', 'cpf': 'xxxxxxxxxxx', 'amount': 10000.0, 'due_date': '2024-05-16T15:00:00Z', 'e2e': 'E18xxxxxx4xxxxAA9Rxxxx', 'qr_code_id': xxxxxx, 'qr_code_status': 'CHARGEBACK', 'qr_code_copy_and_paste': '00020101021226970014br.gov.bcb.pix2575qr-h.cornerpix.com.br/11581339/v2/cobv/fafaf5d3-f8a6-45bc-8b80-e4e94f99c92d5204000053039865802BR5914BMP MONEY PLUS6009SAO PAULO62070503***63048904'}}
| Field | Description |
|---|---|
| type | PIX_MED_RECEIVE - Generated dispute over a PIX by the Central Bank PIX_MED_RESPONSE_SEND - Response sent regarding the Chargeback/MED, accepting or rejecting the request. PIX_MED_RESPONSE_RECEIVE - Response received regarding the Chargeback/MED |
| data | Returns the date |
| name | Returns the Payer's name |
| cpf | Returns the Payer's document (cpf) |
| amount | Returns the amount |
| due_date | Returns the due date |
| e2e | Returns the e2e (End-to-End), a unique identifier used in financial transactions to facilitate the identification and tracking of operations. |
| qr_code_id | Unique payment identifier generated. This value never repeats, and it enables querying endpoints to confirm the payment status, refunds, etc. |
| qr_code_status | NEW - Payment generated, awaiting payment by the customer PAID - Payment successfully completed CANCELED - Payment canceled / expired |
| qr_code_copy_and_paste | Returns the QRCode Copy and Paste |
PIX CASH OUT
{
"type": "PIX_CASHOUT_CREATED",
"data": {
"amount": 0.01,
"code_transaction": "***********7535f2ee8",
"fee": 0.0,
"from_accout": "****",
"key": "lr*********@gmail.com",
"status": "NEW",
"tag": null,
"transaction_id": ******
}
}
| Field | Description |
|---|---|
| type | PIX_CASHOUT_CREATED - Payment generated or awaiting approval PIX_CASHOUT_SUCCESS - Payment successfully completed PIX_CASHOUT_ERROR - Payment not completed due to errors in the provided data |
| amount | Returns the amount |
| code_transaction | Returns a unique identifier (EndtoEnd) |
| fee | Returns the fee that will be charged to the SaQ.Digital customer (if applicable) |
| from_accout | Returns information about the originating account. |
| key | Returns the Pix key. |
| 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 |