# Create Biometric PIX

**POST** `/dpm/payments-gwproxy/v2/payments/biometric/pix`

Base URL: `https://api.pre.globalgetnet.com`

__Generate Payment with Biometric PIX__<br><br>

This endpoint processes payment data and instantly creates a unique Biometric PIX. Upon successful payment by the customer, 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>

**Notes:**<br>
- Biometric PIX authenticates the payer through Open Finance before the payment completes.<br>
- A `201` response can still carry a business-level `ERROR` status. Check `status` in the response body.

## Authorization

- PROD (oauth2)
- PRE (oauth2)
- SBX (oauth2)

## Header parameters

- `x-seller-id` (string, required)
  Unique identifier of the commercial establishment (seller) registered on the Getnet platform.
- `x-biometric-expiration-time` (number)
  It is possible to customize the expiration time of the biometric 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 <a href="https://docs.globalgetnet.com/es/articles/currency-codes">this</a> section).
- `order_id` (string)
  Purchase identification code used by e-commerce (code or order number).
- `idempotency_key` (string, required)
  Idempotency key, used to control requests, must be unique per request, because if it is repeated, it will always be returned the same data.
- `customer` (object, required)
  - `document_number` (string, required)
    Customer tax ID.
  - `name` (string, required)
    Customer name.

Example:

```json
{
  "amount": 8900,
  "currency": "BRL",
  "order_id": "ORDER-10187383",
  "idempotency_key": "1eb2412c-165a-41cd-b1d9-76c575d30a21",
  "customer": {
    "document_number": "29718971092",
    "name": "João Silva"
  }
}
```

## Responses

### 201

Biometric PIX created

- `payment_id` (string<uuid>, required)
  Unique identifier for the created payment.
- `status` (string, required)
  The current status of the payment.
- `description` (string, required)
  A message confirming the biometric payment generation.
- `additional_data` (object, required)
  Contains payment specific data, including the PIX details.
  - `transaction_id` (string<uuid>, required)
    Internal transaction identifier.
  - `jsr_url` (string, required)
    URL for JSR redirect.
  - `creation_date` (string<date-time>, required)
    Timestamp of when the PIX was created.
  - `expiration_date` (string<date-time>, required)
    Timestamp of when the biometric will expire.
  - `psp_code` (string, required)
    The PSP (Payment Service Provider) code used for the transaction.
- `idempotency_key` (string<uuid>, required)
  Unique key used to ensure a payment request is processed only once.

Example:

```json
{
  "payment_id": "03ec0ede-3bc9-42dd-a71b-1c3a670b2b89",
  "status": "WAITING",
  "description": "The biometric payment has been successfully generated and is awaiting payment.",
  "additional_data": {
    "transaction_id": "890005df15a2-0b1e-4c6e-8ece-11a71070be06",
    "jsr_url": "https://ob-hosted-payment-page.hml.linaob.com.br/payments?paymentLinkId=3b54d7fd-42f9-49a4-a8d7-eef965f01b79",
    "creation_date": "2025-10-20T18:55:55",
    "expiration_date": "2025-10-20T18:58:58",
    "psp_code": "0033"
  },
  "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<int32>)
  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<int32>)
  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<int32>)
  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<int32>)
  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"
    }
  ]
}
```