post
https://api.somossimpay.com.br/v2/finance/create-pix-copy-and-paste/
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). | 57373705c83bc5efe41001790c54642e670088c0c87d56bc8f990f2260c7740b99f4081ff231b87f82118c1e77a959e1f40eacf690a8fa61a827a9ba01d546f6) |
Body Details
{
"amount": 0.01,
"type_fine": "NONE",
"due_date": "2025-12-14T12:00:00.000Z",
"expiration_date": "2025-12-15T12:00:00.000Z",
"fine_date": "2025-12-15T12:00:00.000Z",
"fine": 0,
"source_account_branch_identifier": "xxxx",
"source_account_number": "xxxxxx",
"type_document": "CPF",
"debtor_document": "xxxxxx",
"debtor_name": "xx",
"tag": "xxxxxxxxxxxxx",
"base_64_image": true
}
| Field | Type | Description | Required or Optional |
|---|---|---|---|
| amount | Decimal | Amount to be paid. | required |
| type_fine | String | NONE , VALUE or PERCENT - In this field, you should inform the type of fine/interest that will be applied. If this condition is not applicable, fill in this field with 'NONE'. If it's necessary to apply the fine/interest condition, use 'VALUE' to input a fixed value or 'PERCENT' to indicate the percentage of the fine that will be charged. Remember that the due_date field is where the date/time when the interest will start to be applied should be input. | required |
| due_date | Datetime | Date and time the payment should expire.If applicable, this field allows payments to be made after the specified time, albeit with additional interest charges. Note: We have implemented a rule that makes these fields optional, allowing the field to be removed from the body. | Optional |
| expiration_date | Datetime | Date and time when the Copy and Paste Or QR Code should expire. Once the defined date and time have been exceeded, it will not be possible to make the payment using the copy and paste code. Additionally, scanning the generated QR Code will not be possible. This field must be set to a date at least one day after the due_date to work correctly. Note: We have implemented a rule that makes these fields optional, allowing the field to be removed from the body. | Optional |
| fine_date | Datetime | Starting from the date provided in this field, a fine will be applied if applicable. This field must be set to a date at least one day after the due_date to work correctly. Note: We have implemented a rule that makes these fields optional, allowing the field to be removed from the body. | Optional |
| fine | Datetime | 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 |
| source_account_branch_identifier | String | 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). | Optional |
| source_account_number | String | 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 typically have 6 characters) ex: 401050 | Optional |
| type_document | String | CPF or CNPJ - You should inform the type of document according to what was provided in the debtor_document field. | Optional |
| debtor_document | String | 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. | Optional |
| debtor_name | String | Payer's name. The maximum value is 25 characters for this field. | Optional |
| tag | String | This is a free field you can use to enter internal numbers and identification. | Optional |
| base_64_image | Boolean | 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 |
Response Details
{
"worked": true,
"pix_copy_and_paste": "00020101021226880014br.gov.bcb.pix2566qrcodes.saq.digital/v2/qr/cob/************************************SAQ INSTITUICAO DE PAGAME6009SAO PAULO62070503***6304E39B",
"qr_code_id": 1,
"debtor_name": "Fulano de tal",
"debtor_document": "15888877743",
"type_document": "CPF",
"debtor_institution": null,
"debtor_institution_number": null,
"expiration_date": "2024-01-01T12:00:00.000Z",
"due_date": null,
"amount_chargeback": 0.0,
"amount": 0.01,
"fee": 0.0,
"type_fine": "NONE",
"fine": null,
"fine_date": null,
"status": "NEW",
"base_64_image": null,
"base_64_image_url": "https://api.saq.digital/v2/finance/image/qrcode/***c.png",
"account_number": "0001",
"agency_number": "0001",
"endToEndId": "",
"payment_date": null,
"tax": null,
"tx_id": "23920262************f770c",
"tag": "description"
}
| 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 | Returns the Payer's name (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) |
| debtor_institution | Returns the payer's debtor institution |
| debtor_institution_number | Returns the debtor institution number (ISPB) |
| type_document | Returns the Payer's type document (the same information that was sent in the body) |
| expiration_date | Returns the expiration date (the same information that was sent in the body) |
| due_date | Returns the due date (the same information that was sent in the body) |
| 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 | Returns the fee amount charged for the transaction (Deprecated) |
| fine_date | Returns the type_fine if applicable |
| 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 | Returns the account Number (the same information that was sent in the body) |
| agency_number | Returns the agency Number (the same information that was sent in the body) |
| endToEndId | Returns the Endtoend ID (the same information that was sent in the body) |
| payment_date | Returns the date and time at which the payment was completed |
| tx_id | Returns the conciliation ID QR Code |
| tax | Returns the fee amount charged for the transaction |
| tag | Returns the tag if applicable (the same information that was sent in the body) |