Generate a PIX Cash In with Rule for Same Document Receipt

Headers

Parameter	Type	Description	Example
Authorization	String	Bearer + Access_token	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzEzMzAwOTMxLCJpYXQiOjE3MTMyOTczMzEsImp0aSI6Ijc2ZWI4ZTE5ZjM4YjQ4NmZiODdmNzNjNTdkMWVmNDJhIiwidXNlcl9pZCI6MjQ2fQ.5zekMa7CUj9p-MvNHns5ke4ZPhYV3Y1CLOsYL7hDUUo
hmac	String	HMAC (Hash-based Message Authentication Code) is an authentication algorithm that combines a private key with a message to create a Message Authentication Code (MAC).	hmac: 57373705c83bc5efe41001790c54642e670088c0c87d56bc8f990f2260c7740b99f4081ff231b87f82118c1e77a959e1f40eacf690a8fa61a827a9ba01d546f6)

Body Details

{
  "amount": 0.01,
  "debtor_name": "M***** V****** F******",
  "debtor_document": "***********",
  "type_document": "CPF",
  "type_fine": "NONE",
  "fine": 0,
  "source_account_branch_identifier": "****",
  "source_account_number": "******",
  "base_64_image": true
}

Field	Description	Required or Optional
amount	Amount to be paid.	required
debtor_name	Payer's name. The maximum value is 25 characters for this field.	Optional
debtor_document	Payer document number which can be either a CPF (Individual Taxpayer Registry) with a length of 11 digits or a CNPJ (National Registry of Legal Entities) with a length of 14 digits.	required
type_document	CPF or CNPJ - You should inform the type of document according to what was provided in the debtor_document field.	required
type_fine	NONE, VALUE, or PERCENT – In this field, you should specify the type of fine/interest that will be applied. If this condition is not applicable, fill in the field with 'NONE'. If it is necessary to apply a fine/interest, use 'VALUE' to input a fixed amount or 'PERCENT' to indicate the percentage of the fine to be charged. If you use VALUE or PERCENT, remember that the due_date field must be included in the body (more details available in the PIX Cashin (PIX Copy and Paste) section with all recommended fields ).	required
source_account_branch_identifier	source_account_branch_identifier: In this field, please provide the number of the originating bank branch from which the Copy and Paste or QR Code Scanning will be generated. The branch number always consists of 4 digits (e.g., 0001).	required
source_account_number	In this field, you should provide the bank account number from which Copy and Paste or QR Code Scanning will be generated. A bank account number does not have a specific pattern and may vary in length depending on the financial institution. (Example: Accounts registered with SaQ.Digital typically have 6 characters) ex: 401050	required
fine	In this field, you should fill in the value that will be charged as fine/interest as indicated in the type_fine field (VALUE or PERCENT). If the type_fine field is filled in as 'NONE', fill in this field with '0'	required
base_64_image	In this field, you can choose whether to include the QR Code's base64 in the response of the request. If the option is set to true, the base64 will be included in the response. If set to false, the base64 will not be included. If the field is left empty, the base64 of the QR Code will be generated by default.	Optional

📘
During the Test Period (POC), the system will return the error of invalid HMAC, along with the correct HMAC that should be inputted.

Response Details

{
    "worked": true,
    "pix_copy_and_paste": "00020101021226950014br.gov.bcb.pix2573qr.cornerpix.com.br/11581339/v2/cobv/ed21b5c6-a53a-440a-bd90-034654e9f2c15204000053039865802BR5914BMP MONEY PLUS6009SAO PAULO62070503***63049117",
    "qr_code_id": xxxx,
    "debtor_name": "xxxx xxxxxx xxxxx",
    "debtor_document": "xxxxxxxxxxx",
    "type_document": "CPF",
    "expiration_date": "2024-05-05T12:00:00",
    "due_date": "2024-05-01T12:00:00.000Z",
    "amount_chargeback": 0,
    "amount": 2.2,
    "fee": 0.0,
    "type_fine": "NONE",
    "fine": 0,
    "fine_date": "2024-05-05T12:00:00.000Z",
    "status": "NEW",
    "base_64_image": "iVBORw0KGgoAAAANSUhEUgAAAhIAAAISAQAAAACxRhsSAAAE2klEQVR4nO2dXWrjShBGT10J8ijBLGCWIu/gLilkZ9JSsoCA9BiQqPtQ3S3ZziQD4/T4mq8fQiTZhxYU1fXzdducPx3TP3+MADHEEEMMMcQQQwwxxNgZlkaLmbUwWYudFjOm/ADYzKwnHsQ43XgeYojxi+Hu7gzu7j43Oavq1njgPjfuPu/3VtK98rXxXt5FjMdnLNk7DjNhiclt9ptBlyw2PgKQfeyt5yGGGL/FmHqApYXp5xq3UgTQg7/0YKca8xBDjE8YPgJ26lZ8XLLHnPrGgc3s+bXlatzru4jxOIwP41MfSYs/g7vv6/7+n+JTMf4CI9L6Hhjmxu15j0WXFobXlrhM/22R7t9+HmKI8fHwq7HiY7eGUz340/FX35A/FePbGWndp3MHmrDTdBn3yMYKyYDDlPMD2akY389I3nEEfOzc858VH2mcIWLWJsWnQwlh3VfZqRi1GKWcT5ROGcL+VoAmGzA5oxqyUZOcr+xUjBqMKDPZMDo2/Vxbn6xxm/o30prfzUD3FjmTw9Y63YzFg5vNQwwxPh3HjCgXova6lI+de/Soxi452hQa0KguJUYtRo5Pc2ga2dMwN8USi3UCKT7tXPVTMaoyij9d2ZOk7DZXkgQl7uXPkbMsxadiVGKUftRZ9lSSeSjLu5851RQQyE7FqMI4tOsjhQIwaByWHmAzWH6sTP++Ad1b6yxAZFQ3m4cYYnw69nU/xaekQlTErEl6mrKs1BSArESVPxWjCiOv+1HEhySHnslhQO6gHuv8pR8gOxWjDuNop3SpZZrL/s1Z+p+rUVk5pX6UGNUYOT7tVkIbBWB0awvdu8Fi6ekwby0RroIdGffyLmI8PmNpc4K/mIUrnfqiP11amOzp0DyF5ckvGLeYhxhifMLYd5sM7u4vZpb0/EsLdO9mp+7dfFzM8ufWb5iHGGJ8PFIuVJQmSRtFkaUU/Wm3Xmr8FZ+KUYlxlkfBQTR12CYd5khWTqWh/r4Y1RgH/emZdTZZvre7Uk9/CBOdUb4vRi3GZX9/H6kGUESo+5I/eKlfyU7FqMI46KWyP901fLlR5edB6qGSKjsVowrj6E8hbYk+FvGhnJECxx3SoHVfjFqM4/6o3W3ue/XLdqmDpCoc7aw8SoxqjMNxZ3E5QrHEvF0vbT/NWr8i6pedilGJcbkbP4tR9jwqXfrlxv5Z8akY9Rmb2Sn6+000T91f20NUEEefPmcJir/0m84/FaMWI+03BXB4N2fZzFl+rNCtrYUwGmAYcYOtZXgtrf2bzUMMMb5muLu7nZancJZ2Yj8+snE7hai/eNsQTZVWwH29ixiPyLjqR+2d0aQ6zQFpMsx07/jde3kXMR6XcbaPb75+kEZzJqUGpEMRoybjKt8vZ0ntTSngQqWyH5omOxWjHmP/vRMf2SzJUSPzTz91EpdxsvTShsXa6cbzEEOMTxmlsG/PEQFsFsr+fc/UyGb7L58AmymPEqMSo+hP4bDpNMy2KPaHQ6rlfvFdrfti1Gf4S994/M6Z9blvOpmZPc+QfCxo3Rfj7zKGs/ZoGOtBxV8O8D2chX637yLGwzA+/r2TIkHJWlMg0qqu1K86nYciRjXGVZkUik56vj4tZSgFrF1KLTsV49sZ5l9/5osx3cu7iCGGGGKIIYYYYojx/2f8B9IqITTyxaRDAAAAAElFTkSuQmCC",
    "base_64_image_url": "https://saq-api-files.s3-sa-east-1.amazonaws.com/media/b4a7ecc3-90c5-4e14-9e7e-e63640646ec9.png"
}

Field	Description
worked	Returns true or false confirming whether the Generate a PIX Cash In (Copy and Paste Or QR Code) was successful or not.
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. This value never repeats, and it enables querying endpoints to confirm the payment status, refunds, etc.
debtor_name	The Payer's name is returned (the same information that was sent in the body)
debtor_document	Returns the Payer's document (the same information that was sent in the body)
type_document	The Payer's document type (the same information that was sent in the body)
expiration_date	The rule is automatically applied and returned in this field.
due_date	The rule is automatically applied and returned in this field.
amount_chargeback	If a refund occurs, this field will be filled with the refunded amount.
amount	Returns the amount (the same information that was sent in the body)
fee	This field returns the fee that will be charged to the SaQ.Digital customer for generating the PIX Cash In (Copy and Paste or QR Code Scanning).
fine_date	The rule is automatically applied and returned in this field.
status	NEW - Payment generated, awaiting payment by the customer PAID - Payment successfully completed CANCELED - Payment canceled / expired
base_64_image	This field returns the generated QRCode image in base64 format
base_64_image_url	This field returns the link with the generated QRCode image. The customer can scan it and pay directly through their bank.
account_number	This field returns the account associated with the generated PIX Cash In. (the same information that was sent in the body)
agency_number	This field returns the agency associated with the generated PIX Cash In. (the same information that was sent in the body)

Headers

Body Details

📘During the Test Period (POC), the system will return the error of invalid HMAC, along with the correct HMAC that should be inputted.

Response Details

📘
During the Test Period (POC), the system will return the error of invalid HMAC, along with the correct HMAC that should be inputted.