# Create PIX
**POST** `/dpm/payments-gwproxy/v2/payments/qrcode/pix`
Base URL: `https://api.pre.globalgetnet.com`
__Generate Payment with PIX__
This endpoint processes payment data and instantly creates a unique PIX QR Code. Upon successful payment, the merchant receives a **real-time HTTP notification** for confirmation. For details on handling confirmation, refer to the **"PIX Notifications"** section in **Notifications 1.1**.
This endpoint supports two use cases. Select the example that matches your integration on the right panel:
- **Standard PIX** — plain QR Code payment with amount, currency, and customer ID.
- **PIX with Split** — distributes the amount across multiple subsellers using `data.additional_data.split`.
**Notes:**
- PIX transactions are processed in real time and cannot be reversed once completed.
- A unique PIX key (QR Code or transaction ID) is required for each payment.
## Authorization
- PROD (oauth2)
- PRE (oauth2)
- SBX (oauth2)
## Header parameters
- `x-qrcode-expiration-time` (number)
It is possible to customize the expiration time of the QR Code by entering the desired time in seconds, if it is not informed the operation will go with the default value of 180s, The maximum value for expiration time is 1800s
## Body
Content type: `application/json`
- `amount` (integer, required)
Purchase value in cents. It must be an integer.
- `currency` (string, required)
Currency identification (See code in this section).
- `order_id` (string)
Purchase identification code used by e-commerce (code or order number).
- `customer_id` (string, required)
Buyer identifier used by e-commerce. Case be informed it will be passed on in the PIX Payment Notification.
- `idempotency_key` (string)
Idempotency key, used to control requests, must be unique per request, because if it is repeated, it will always be returned the same data.
- `data` (object)
Group of transaction data, including additional information such as split, device, and customer details.
- `additional_data` (object)
Additional authorization data. Required field for payment split.
- `split` (object)
Data for split payment. Required field for payment split.
- `subseller_list_payment` (object[], required)
List of Stores and their due amounts for payment.
- `subseller_id` (string, required)
Subseller ID registered on the marketplace platform (MGM).
- `document_type` ("CPF" | "CNPJ")
Sub-trade document type.
- `document_number` (string, required)
Sub-trade document number without punctuation. (without mask)
- `subseller_sale_amount` (integer, required)
Part of the Store Value in relation to the Order (in cents).
- `items` (object[], required)
List of Subtrade items.
- `id` (string, required)
Item/Product Identifier.
- `description` (string, required)
Item/Product Description.
- `currency` (string)
Currency identification code for the item.
- `amount` (integer, required)
Item/Product value (in cents).
- `transaction_rate_percent` (number)
Fee to be charged on the item in percentage if not send the rate will be set the same as the registration.
If transaction_rate_percent is informed, the transaction_rate_amount should not be sent.
Note: If transaction_rate_percent and transaction_rate_amount are sent for the same item the values will be added together.
- `transaction_rate_amount` (integer)
Fee to be charged on the item in value (in cents) if you do not send the fee will be set the same as the registration.
If transaction_rate_amount is informed, the transaction_rate_percent must not be sent.
Note: If transaction_rate_percent and transaction_rate_amount are sent to the same item the values will be added.
- `payment_plan` (integer)
Subseller Payment Plan.
- `device` (object)
Set of data referring to the device used by the buyer.Required fields for Antifraud
- `ip_address` (string, required)
string IP address (IPv4) of the buyer's device. This attribute must be captured by your application, from the device of the buyer (mobile; browser; etc.) and sent in the payload, in order to enrich our preventive analyses.
- `device_id` (string, required)
Device unique Id.
- `finger_print` (string, required)
Identification hash (Device Fingerprint) of the device.
- `customer` (object)
- `document_type` (string)
Type of the buyer's identification document. Mandatory for billet. Suggested Values CPF, CNPJ, RNE, RG, CNAE, UYCI, PASSPORT ou Document in accordance with current legislation in the country of origin
See all the accepted types here.
Mandatory field for Antifraude
- `document_number` (string)
Purchaser's document number without punctuation. (without mask) Mandatory field for Antifraud
- `email` (string)
Purchaser's email. Mandatory field for Antifraud
- `name` (string)
Purchaser's name. Mandatory field for Antifraud
- `phone_number` (string)
Purchaser's phone number. Mandatory field for Antifraud
- `billing_address` (object)
- `street` (string)
Street. Mandatory field for Antifraud
- `number` (string)
Street number. Mandatory field for Antifraud
- `district` (string)
District. Mandatory field for Antifraud
- `city` (string)
City. Mandatory field for Antifraud
- `state` (string)
State (UF). Mandatory field for Antifraud
- `country` (string)
Country. Report in the ISO 3166-1 alpha-3 standard Example "BRA", "USA" and "ARG" Mandatory field for Antifraud
- `postal_code` (string)
Postal Code, CEP in Brazil or ZIP in the United States. (without mask) Mandatory field for Antifraud
- `complement` (string)
Address complement. Mandatory field for Antifraud
- `type` ("RESIDENCIAL" | "INSTALACAO" | "CORRESPONDENCIA" | "FISCAL" | "COBRANCA")
- `shippings` (object)
- `address` (string)
Set of data referring to the buyer's address
- `street` (string)
- `number` (string)
- `district` (string)
- `city` (string)
- `country` (string)
- `postal_code` (string)
- `complement` (string)
- `type` (string)
- `billing_address` (object)
- `street` (string)
Street. Mandatory field for Antifraud
- `number` (string)
Street number. Mandatory field for Antifraud
- `district` (string)
District. Mandatory field for Antifraud
- `city` (string)
City. Mandatory field for Antifraud
- `state` (string)
State (UF). Mandatory field for Antifraud
- `country` (string)
Country. Report in the ISO 3166-1 alpha-3 standard Example "BRA", "USA" and "ARG" Mandatory field for Antifraud
- `postal_code` (string)
Postal Code, CEP in Brazil or ZIP in the United States. (without mask) Mandatory field for Antifraud
- `complement` (string)
Address complement. Mandatory field for Antifraud
- `type` ("RESIDENCIAL" | "INSTALACAO" | "CORRESPONDENCIA" | "FISCAL" | "COBRANCA")
- `shippings` (object)
- `address` (string)
Set of data referring to the buyer's address
- `street` (string)
- `number` (string)
- `district` (string)
- `city` (string)
- `country` (string)
- `postal_code` (string)
- `complement` (string)
- `type` (string)
- `cross_border_data` (object)
Data structure containing data about cross-border (FX) transactions.
- `consumer_data` (object, required)
Customer data
- `email` (string, required)
Email address that will be used to send the cross-border transaction receipt
- `first_name` (string, required)
Customer first name. Required when type = INDIVIDUAL.
- `last_name` (string, required)
Customer last name. Required when type = INDIVIDUAL.
- `legal_name` (string, required)
Company name. Required when type = COMPANY.
- `document_number` (string, required)
Customer document number.
- `type` ("INDIVIDUAL" | "COMPANY", required)
Type of customer.
Example:
```json
{
"amount": 8900,
"currency": "BRL",
"order_id": "ORDER-10187383",
"customer_id": "customer_21081826",
"idempotency_key": "1eb2412c-165a-41cd-b1d9-76c575d30a21",
"data": {
"additional_data": {
"split": {
"subseller_list_payment": [
{
"subseller_id": "700104158",
"document_type": "CNPJ",
"document_number": "12345678912",
"subseller_sale_amount": 118708,
"items": [
null
]
}
]
},
"device": {
"ip_address": "10.0.0.1",
"device_id": "ae44e06c-3e85-44af-8542-bcaccd54ef2e",
"finger_print": "aGVsbG8td29ybGQtZGV2aWNlLWlkCg=="
},
"customer": {
"document_type": "CPF",
"document_number": 2441356709,
"email": "aceiti@getnet.com.br",
"name": "Jose da Silva",
"phone_number": 11999999999,
"billing_address": {
"street": "string",
"number": "string",
"district": "string",
"city": "string",
"state": "string",
"country": "string",
"postal_code": "string",
"complement": "string",
"type": "RESIDENCIAL"
},
"shippings": {
"address": "string",
"street": "string",
"number": "string",
"district": "string",
"city": "string",
"country": "string",
"postal_code": "string",
"complement": "string",
"type": "string"
}
},
"billing_address": {
"street": "string",
"number": "string",
"district": "string",
"city": "string",
"state": "string",
"country": "string",
"postal_code": "string",
"complement": "string",
"type": "RESIDENCIAL"
},
"shippings": {
"address": "string",
"street": "string",
"number": "string",
"district": "string",
"city": "string",
"country": "string",
"postal_code": "string",
"complement": "string",
"type": "string"
},
"cross_border_data": {
"consumer_data": {
"email": "customer@email.com",
"first_name": "John",
"last_name": "Doe",
"legal_name": "ABC Corporation",
"document_number": "80026928027",
"type": "INDIVIDUAL"
}
}
}
}
}
```
## Responses
### 201
Payment successfully created, QR Code generated, and awaiting payment
- `payment_id` (string, required)
Unique identifier for the created payment.
- `status` ("PENDING" | "APPROVED" | "DENIED" | "ERROR", required)
Pix Status
- `description` (string, required)
A message confirming the QR code generation.
- `additional_data` (object)
Contains payment specific data, including the PIX details.
- `transaction_id` (string)
Internal transaction identifier.
- `qr_code` (string)
The PIX string representing the QR Code payload (Pix Copy and paste).
- `qr_code_nfc` (string)
The PIX EMV payload for the NFC (Pix por aproximação) QR Code. Present it in graphic mode or read it by NFC, alongside the standard `qr_code` Copy and paste string.
- `aids` (string[])
List of Application Identifiers (AIDs) associated with the NFC QR Code.
- `creation_date_qrcode` (string)
Timestamp of when the QR code was created.
- `expiration_date_qrcode` (string)
Timestamp of when the QR code will expire.
- `psp_code` (string)
The PSP (Payment Service Provider) code used for the transaction.
- `extra_time_qrcode` (integer)
Additional time, in seconds, granted for the QR Code payment.
- `is_split` (boolean)
Indicates if the payment is subject to splitting.
- `idempotency_key` (string)
Unique key used to ensure a payment request is processed only once.
Example:
```json
{
"payment_id": "03ec0ede-3bc9-42dd-a71b-1c3a670b2b89",
"status": "PENDING",
"description": "QR Code successfully generated and awaiting payment.",
"additional_data": {
"transaction_id": "890005df15a2-0b1e-4c6e-8ece-11a71070be06",
"qr_code": "00020101021226740014br.bcb.pix...",
"qr_code_nfc": "00020101021226870014br.gov.bcb.pix2565pix-h.santander.com.br/qr/nfc/...6304....",
"aids": [
"A00000047643276C1FDE7A39B9C05716"
],
"creation_date_qrcode": "2025-10-20T18:55:55",
"expiration_date_qrcode": "2025-10-20T18:58:58",
"psp_code": "033",
"extra_time_qrcode": 180
},
"is_split": false,
"idempotency_key": "e757d73e-fbdb-40ee-a72b-6f06f19c7a27"
}
```
### 400
Bad Request
- `message` (string)
Detailed error message.
- `name` (string)
Name of the module or system in which the error occurred.
- `status_code` (integer)
HTTP status code of the error.
- `details` (object[])
Error details.
- `status` (string)
Error situation.
- `error_code` (string)
Error code.
- `description` (string)
Description of the error.
- `description_detail` (string)
Detailed description of the error.
Example:
```json
{
"message": "string",
"name": "string",
"status_code": 0,
"details": [
{
"status": "string",
"error_code": "string",
"description": "string",
"description_detail": "string"
}
]
}
```
### 401
Unauthorized
- `message` (string)
Detailed error message.
- `name` (string)
Name of the module or system in which the error occurred.
- `status_code` (integer)
HTTP status code of the error.
- `details` (object[])
Error details.
- `status` (string)
Error situation.
- `error_code` (string)
Error code.
- `description` (string)
Description of the error.
- `description_detail` (string)
Detailed description of the error.
Example:
```json
{
"message": "string",
"name": "string",
"status_code": 0,
"details": [
{
"status": "string",
"error_code": "string",
"description": "string",
"description_detail": "string"
}
]
}
```
### 404
Not Found
- `message` (string)
Detailed error message.
- `name` (string)
Name of the module or system in which the error occurred.
- `status_code` (integer)
HTTP status code of the error.
- `details` (object[])
Error details.
- `status` (string)
Error situation.
- `error_code` (string)
Error code.
- `description` (string)
Description of the error.
- `description_detail` (string)
Detailed description of the error.
Example:
```json
{
"message": "string",
"name": "string",
"status_code": 0,
"details": [
{
"status": "string",
"error_code": "string",
"description": "string",
"description_detail": "string"
}
]
}
```
### 500
Internal Server Error
- `message` (string)
Detailed error message.
- `name` (string)
Name of the module or system in which the error occurred.
- `status_code` (integer)
HTTP status code of the error.
- `details` (object[])
Error details.
- `status` (string)
Error situation.
- `error_code` (string)
Error code.
- `description` (string)
Description of the error.
- `description_detail` (string)
Detailed description of the error.
Example:
```json
{
"message": "string",
"name": "string",
"status_code": 0,
"details": [
{
"status": "string",
"error_code": "string",
"description": "string",
"description_detail": "string"
}
]
}
```