Getnet DocsGetnet Docs

Create PIX

POST/dpm/payments-gwproxy/v2/payments/qrcode/pix

__Generate Payment with PIX__<br><br> 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**.<br><br> This endpoint supports two use cases. Select the example that matches your integration on the right panel:<br><br> - **Standard PIX** — plain QR Code payment with amount, currency, and customer ID.<br> - **PIX with Split** — distributes the amount across multiple subsellers using `data.additional_data.split`.<br> **Notes:**<br> - PIX transactions are processed in real time and cannot be reversed once completed.<br> - A unique PIX key (QR Code or transaction ID) is required for each payment.

Header Parameters

x-qrcode-expiration-timenumber

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 application/json

amountintegerrequired

Purchase value in cents. It must be an integer.

currencystringrequired

Currency identification (See code in <a href="https://docs.globalgetnet.com/es/articles/currency-codes">this</a> section).

order_idstring

Purchase identification code used by e-commerce (code or order number).

customer_idstringrequired

Buyer identifier used by e-commerce. Case be informed it will be passed on in the PIX Payment Notification.

idempotency_keystring

Idempotency key, used to control requests, must be unique per request, because if it is repeated, it will always be returned the same data.

dataobject

Group of transaction data, including additional information such as split, device, and customer details.

Show data properties
additional_dataobject

Additional authorization data. Required field for payment split.

Show additional_data properties
splitobject

Data for split payment. Required field for payment split.

Show split properties
subseller_list_paymentobject[]required

List of Stores and their due amounts for payment.

Show subseller_list_payment properties
subseller_idstringrequired

Subseller ID registered on the marketplace platform (MGM).

document_type"CPF" | "CNPJ"

Sub-trade document type.

document_numberstringrequired

Sub-trade document number without punctuation. (without mask)

subseller_sale_amountintegerrequired

Part of the Store Value in relation to the Order (in cents).

itemsobject[]required

List of Subtrade items.

Show items properties
idstringrequired

Item/Product Identifier.

descriptionstringrequired

Item/Product Description.

currencystring

Currency identification code for the item.

amountintegerrequired

Item/Product value (in cents).

transaction_rate_percentnumber

Fee to be charged on the item in percentage if not send the rate will be set the same as the registration. <br />If <b>transaction_rate_percent</b> is informed, the <b>transaction_rate_amount</b> should not be sent. <br />Note: If <b>transaction_rate_percent</b> and <b>transaction_rate_amount</b> are sent for the same item the values ​​will be added together.

transaction_rate_amountinteger

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. <br />If <b>transaction_rate_amount</b> is informed, the <b>transaction_rate_percent</b> must not be sent. <br />Note: If <b>transaction_rate_percent</b> and <b>transaction_rate_amount</b> are sent to the same item the values ​​will be added.

payment_planinteger

Subseller Payment Plan.

deviceobject

Set of data referring to the device used by the buyer.</br><b><i>Required fields for <a href="https://docs.globalgetnet.com/es/products/online-payments/regional-api?doc=api-ref-antifraud">Antifraud</a></i></b>

Show device properties
ip_addressstringrequired

string <IPv4> 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_idstringrequired

Device unique Id.

finger_printstringrequired

Identification hash (Device Fingerprint) of the device.

customerobject
Show customer properties
document_typestring

Type of the buyer's identification document. Mandatory for billet. </br> Suggested Values <b>CPF</b>, <b>CNPJ</b>, <b>RNE</b>, <b>RG</b>, <b>CNAE</b>, <b>UYCI</b>, <b>PASSPORT</b> ou <b>Document in accordance with current legislation in the country of origin<br><br>See all the accepted types <a href="https://docs.globalgetnet.com/es/articles/document-types">here.</a><br><br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/idempotency#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude">Antifraude</a></i></b></b>

document_numberstring

Purchaser's document number without punctuation. (without mask) </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

emailstring

Purchaser's email. </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

namestring

Purchaser's name. </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

phone_numberstring

Purchaser's phone number. </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

billing_addressobject
Show billing_address properties
streetstring

Street. </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

numberstring

Street number. </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

districtstring

District. </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

citystring

City. </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

statestring

State (UF). </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

countrystring

Country. </br> Report in the ISO 3166-1 alpha-3 standard </br> Example "BRA", "USA" and "ARG" </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

postal_codestring

Postal Code, CEP in Brazil or ZIP in the United States. (without mask) </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

complementstring

Address complement. </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

type"RESIDENCIAL" | "INSTALACAO" | "CORRESPONDENCIA" | "FISCAL" | "COBRANCA"
shippingsobject
Show shippings properties
addressstring

Set of data referring to the buyer's address

streetstring
numberstring
districtstring
citystring
countrystring
postal_codestring
complementstring
typestring
billing_addressobject
Show billing_address properties
streetstring

Street. </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

numberstring

Street number. </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

districtstring

District. </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

citystring

City. </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

statestring

State (UF). </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

countrystring

Country. </br> Report in the ISO 3166-1 alpha-3 standard </br> Example "BRA", "USA" and "ARG" </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

postal_codestring

Postal Code, CEP in Brazil or ZIP in the United States. (without mask) </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

complementstring

Address complement. </br><b><i>Mandatory field for <a href="https://developers.getnet.com.br/api#section/Antifraude/Dados-obrigatorios-para-analise-do-Antifraude"> Antifraud</a></i></b>

type"RESIDENCIAL" | "INSTALACAO" | "CORRESPONDENCIA" | "FISCAL" | "COBRANCA"
shippingsobject
Show shippings properties
addressstring

Set of data referring to the buyer's address

streetstring
numberstring
districtstring
citystring
countrystring
postal_codestring
complementstring
typestring
cross_border_dataobject

Data structure containing data about cross-border (FX) transactions.

Show cross_border_data properties
consumer_dataobjectrequired

Customer data

Show consumer_data properties
emailstringrequired

Email address that will be used to send the cross-border transaction receipt

first_namestringrequired

Customer first name. Required when type = INDIVIDUAL.

last_namestringrequired

Customer last name. Required when type = INDIVIDUAL.

legal_namestringrequired

Company name. Required when type = COMPANY.

document_numberstringrequired

Customer document number.

type"INDIVIDUAL" | "COMPANY"required

Type of customer.

Response

Payment successfully created, QR Code generated, and awaiting payment

payment_idstring<uuid>

Unique identifier for the created payment.

status"PENDING" | "APPROVED" | "DENIED" | "ERROR"

Pix Status

descriptionstring

A message confirming the QR code generation.

additional_dataobject

Contains payment specific data, including the PIX details.

Show additional_data properties
transaction_idstring<uuid>

Internal transaction identifier.

qr_codestring

The PIX string representing the QR Code payload (Pix Copy and paste).

qr_code_nfcstring

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.

aidsstring[]

List of Application Identifiers (AIDs) associated with the NFC QR Code.

creation_date_qrcodestring<date-time>

Timestamp of when the QR code was created.

expiration_date_qrcodestring<date-time>

Timestamp of when the QR code will expire.

psp_codestring

The PSP (Payment Service Provider) code used for the transaction.

extra_time_qrcodeinteger

Additional time, in seconds, granted for the QR Code payment.

is_splitboolean

Indicates if the payment is subject to splitting.

idempotency_keystring<uuid>

Unique key used to ensure a payment request is processed only once.

Bad Request

messagestring

Detailed error message.

namestring

Name of the module or system in which the error occurred.

status_codeinteger<int32>

HTTP status code of the error.

detailsobject[]

Error details.

Show details properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

Unauthorized

messagestring

Detailed error message.

namestring

Name of the module or system in which the error occurred.

status_codeinteger<int32>

HTTP status code of the error.

detailsobject[]

Error details.

Show details properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

Not Found

messagestring

Detailed error message.

namestring

Name of the module or system in which the error occurred.

status_codeinteger<int32>

HTTP status code of the error.

detailsobject[]

Error details.

Show details properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

Internal Server Error

messagestring

Detailed error message.

namestring

Name of the module or system in which the error occurred.

status_codeinteger<int32>

HTTP status code of the error.

detailsobject[]

Error details.

Show details properties
statusstring

Error situation.

error_codestring

Error code.

descriptionstring

Description of the error.

description_detailstring

Detailed description of the error.

Request
curl -X POST "https://api.pre.globalgetnet.com/dpm/payments-gwproxy/v2/payments/qrcode/pix" \
  -H "Content-Type: application/json" \
  -H "x-qrcode-expiration-time: <x-qrcode-expiration-time>" \
  -d '{
  "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": "[email protected]",
        "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": "[email protected]",
          "first_name": "John",
          "last_name": "Doe",
          "legal_name": "ABC Corporation",
          "document_number": "80026928027",
          "type": "INDIVIDUAL"
        }
      }
    }
  }
}'
Response
{
  "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"
}