# Create an Invoice/Boleto

**POST** `/dpm/payments-gwproxy/v2/payments/boleto`

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

__Generate Payment with Boleto__<br><br>

The Boleto endpoint allows merchants to generate a bank slip (boleto) for customers to complete payments via banking channels, ATMs, or authorized locations. It offers an alternative payment method for customers without credit or debit cards and enables cash-based transactions with a due date for payment.<br><br>

**Notes:**<br>
- The boleto must include an expiration date, after which payment is no longer valid.<br>
- Once generated, the boleto cannot be modified; a new one must be issued if changes are required.<br>
- Payment confirmation times vary depending on the bank’s processing policies.

## Authorization

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

## Body

Content type: `application/json`

- `idempotency_key` (string<(a-Z | 0-9 | .-_)>, 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.
- `request_id` (string<uuid>, required)
  Request identifier. Unique for each request.
- `data` (object, required)
  - `amount` (integer)
    Purchase value in cents. It must be an integer.
  - `currency` (string)
    Currency identification (See code in <a href="https://docs.globalgetnet.com/es/articles/currency-codes">this</a> section).
  - `payment` (object)
    - `payment_id` (string)
    - `payment_method` (string)
  - `order` (object)
    Set of data for identifying the purchase
    - `order_id` (string, required)
      Purchase identification code used by the e-commerce
    - `sales_tax` (number)
      Tax value in percentage.
    - `product_type` ("cash_carry" | "digital_content" | "digital_goods" | "digital_physical" | "gift_card" | "physical_goods" | "renew_subs" | "shareware" | "service")
      Identifier of the type of product sold among the options
  - `customer` (any)
    Set of data referring to the buyer.
  - `boleto` (object)
    Data for generating the billet
    - `our_number` (string)
      Named by banks as "Our Number". is the identification billet only in the billing system and does not have a mask. It's composed by rules that vary depending on the bank and collection service. Per For example, in the case of Santander there are two ways of numbering&#58; 1) If the customer informs the number, the customer is in charge of informing the dv (check digit); 2) If the customer omits the number, the Bank is in charge of generating a sequel, without a DV.
    - `document_number` (string)
      Your Number. Number controlled by the customer, it is usually managed by the system that is generating the ticket. (without mask)
    - `expiration_date` (string<dd/mm/yyyy>)
      Ticket expiration date. If not informed, it will be considered the pre-registered standard number of days for expiration.
    - `instructions` (string)
      Instructions to be printed on the ticket. The line break can be performed in two ways. 1) Automatic line wrapping&#58; it will be A line break is made in up to 100 characters without the words being truncated; 2) Manual line break&#58; line break using the "<br>" escape character. Example&#58; "This is a break test line.<br>The second line will be printed now.<br>And finally, the third line.";
    - `provider` ("santander")
      Provider bank.
    - `guarantor_name` (string)
      Name of the guarantor.
    - `guarantor_document_type` (string)
      Type of document of the guarantor.
    - `guarantor_document_number` (string)
      Number of the guarantor's document.
  - `additional_data` (any)

Example:

```json
{
  "idempotency_key": "63c7f8ee-51a6-470d-bb76-ef762b62bfb7",
  "request_id": "daac03dc-73db-453f-9bea-b1391669d5d3",
  "data": {
    "amount": 8900,
    "currency": "BRL",
    "payment": {
      "payment_id": "string",
      "payment_method": "string"
    },
    "order": {
      "order_id": "6d2e4380-d8a3-4ccb-9138-c289182818a3",
      "sales_tax": 12,
      "product_type": "service"
    },
    "customer": {
      "first_name": "John",
      "last_name": "da Silva",
      "name": "João da Silva",
      "document_type": "CPF",
      "document_number": "12345678912",
      "email": "customer@email.com.br",
      "phone_number": "5551999887766",
      "billing_address": {
        "street": "Av. Brazil",
        "number": "1000",
        "complement": "Sala 1",
        "district": "Sao Geraldo",
        "city": "Porto Alegre",
        "state": "RS",
        "country": "Brazil",
        "postal_code": "90230060"
      }
    },
    "boleto": {
      "our_number": "19465999",
      "document_number": "34602387802",
      "expiration_date": "16/11/2030",
      "instructions": "Não receber após o vencimento",
      "provider": "santander",
      "guarantor_name": "Ze small",
      "guarantor_document_type": "CPF",
      "guarantor_document_number": "78009200021"
    },
    "additional_data": {
      "split": {
        "subseller_list_payment": [
          {
            "subseller_id": "700104158",
            "document_type": "CNPJ",
            "document_number": "12345678912",
            "subseller_sale_amount": 118708,
            "items": [
              null
            ]
          }
        ]
      }
    }
  }
}
```

## Responses

### 201

Created

- `seller_id` (string<uuid>)
- `payment_guid` (string<uuid>)
- `created` (string<date-time>)
- `modified` (string<date-time>)
- `payment_id` (string<uuid>)
- `amount` (integer<int64>)
  Payment amount in cents (or the smallest currency unit).
- `currency` (string)
- `order_id` (string<uuid>)
- `status` ("REGISTERED" | "CANCELED" | "PAID" | "ERROR")
  Boleto Status
- `received_at` (string<date-time>)
- `boleto` (object)
  - `boleto_id` (string<uuid>)
  - `boleto_guid` (string<uuid>)
  - `status_code` (string)
  - `status_label` (string)
  - `our_number` (string)
  - `document_number` (string)
  - `expiration_date` (string)
  - `issue_date` (string)
  - `typeful_line` (string)
  - `bank` (string)
  - `payment_place` (string)
  - `currency_type` (string)
  - `accept` (string)
  - `document_date` (string<date-time>)
  - `bar_code` (string)
  - `mensagem` (string)
  - `assignor` (object)
  - `customer` (object)
    - `name` (string)
    - `document_number` (string)
    - `billing_address` (object)
      - `street` (string)
      - `number` (string)
      - `complement` (string)
      - `district` (string)
      - `city` (string)
      - `state` (string)
      - `postal_code` (string)
- `_links` (object[])
  - `href` (string<uri-reference>)
  - `rel` (string)
  - `type` (string)
- `_id` (string)

Example:

```json
{
  "seller_id": "e0ed6f00-fdc5-46d6-9557-6a2cac641b09",
  "payment_guid": "fff5c9a8-e961-448b-9337-52d54bc6063c",
  "created": "2025-10-21T13:19:46.000Z",
  "modified": "2025-10-21T13:19:46.000Z",
  "payment_id": "e9595164-deaa-4341-bb37-b4b9c570a6d3",
  "amount": 8900,
  "currency": "BRL",
  "order_id": "6d2e4380-d8a3-4ccb-9138-c289182818a3",
  "status": "REGISTERED",
  "received_at": "2025-10-21T13:19:46.000Z",
  "boleto": {
    "boleto_id": "1447f852-96ba-4396-bc36-575b3a3cc5f4",
    "boleto_guid": "784432a8-7de3-4fa4-91be-b5862505be75",
    "status_code": "1",
    "status_label": "EM ABERTO",
    "our_number": "0001946598.0",
    "document_number": "170500000019763",
    "expiration_date": "16/11/2030",
    "issue_date": "21/10/2025",
    "typeful_line": "01010.01010 01010.010101 01010.010101 1 01010101010101",
    "bank": "033",
    "payment_place": "PAGAR PREFERENCIALMENTE EM UMA AGENCIA DO BANCO SANTANDER S.A.",
    "currency_type": "R$",
    "accept": "N",
    "document_date": "2025-10-21T13:19:46.000Z",
    "bar_code": "03393775500000002009589193012345678901230101",
    "mensagem": "Not receiving after due date\nDados ficticios, nao efetuar o pagamento deste boleto",
    "assignor": {},
    "customer": {
      "name": "João da Silva",
      "document_number": "12345678912",
      "billing_address": {
        "street": "Av. Brazil",
        "number": "1000",
        "complement": "Sala 1",
        "district": "Sao Geraldo",
        "city": "Porto Alegre",
        "state": "RS",
        "postal_code": "90230060"
      }
    }
  },
  "_links": [
    {
      "href": "/v1/payments/boleto/e9595164-deaa-4341-bb37-b4b9c570a6d3/pdf",
      "rel": "boleto_pdf",
      "type": "GET"
    }
  ],
  "_id": "68f78872274ffe81a58aa651"
}
```

### 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.
  - `brand` (string)
    Brand.
  - `payment_id` (string)
    payment_id.
  - `seller_id` (string)
    seller_id.
  - `amount` (string)
    amount.
  - `currency` (string)
    currency.
  - `order_id` (string)
    order_id.
  - `credit_cancel` (object)
    credit_cancel.
    - `canceled_at` (string)
      canceledAt.
    - `message` (string)
      message.
  - `payment_tag` (string)
    payment_tag.
  - `status_code` (string)
    statusCode.
  - `message` (string)
    message.
  - `name` (string)
    name.
  - `acquirer_transaction_id` (string)
    acquirer_transaction_id.
  - `authorization_code` (string)
    authorization_code.
  - `transaction_id` (string)
    transaction_id.
  - `reason_code` (string)
    reason_code.
  - `reason_message` (string)
    reason_message.
  - `merchant_advice_code` (string)
    merchant_advice_code.
- `payments` (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.
  - `brand` (string)
    Brand.
  - `payment_id` (string)
    payment_id.
  - `seller_id` (string)
    seller_id.
  - `amount` (string)
    amount.
  - `currency` (string)
    currency.
  - `order_id` (string)
    order_id.
  - `credit_cancel` (object)
    credit_cancel.
    - `canceled_at` (string)
      canceledAt.
    - `message` (string)
      message.
  - `payment_tag` (string)
    payment_tag.
  - `status_code` (string)
    statusCode.
  - `message` (string)
    message.
  - `name` (string)
    name.
  - `acquirer_transaction_id` (string)
    acquirer_transaction_id.
  - `authorization_code` (string)
    authorization_code.
  - `transaction_id` (string)
    transaction_id.
  - `reason_code` (string)
    reason_code.
  - `reason_message` (string)
    reason_message.
  - `merchant_advice_code` (string)
    merchant_advice_code.
- `combined_id` (string)
  combinedId.
- `order_id` (string)
  orderId.
- `seller_id` (string)
  sellerId.

Example:

```json
{
  "message": "string",
  "name": "string",
  "status_code": 0,
  "details": [
    {
      "status": "string",
      "error_code": "string",
      "description": "string",
      "description_detail": "string",
      "brand": "string",
      "payment_id": "string",
      "seller_id": "string",
      "amount": "string",
      "currency": "string",
      "order_id": "string",
      "credit_cancel": {
        "canceled_at": "string",
        "message": "string"
      },
      "payment_tag": "string",
      "status_code": "string",
      "message": "string",
      "name": "string",
      "acquirer_transaction_id": "string",
      "authorization_code": "string",
      "transaction_id": "string",
      "reason_code": "string",
      "reason_message": "string",
      "merchant_advice_code": "string"
    }
  ],
  "payments": [
    {
      "status": "string",
      "error_code": "string",
      "description": "string",
      "description_detail": "string",
      "brand": "string",
      "payment_id": "string",
      "seller_id": "string",
      "amount": "string",
      "currency": "string",
      "order_id": "string",
      "credit_cancel": {
        "canceled_at": "string",
        "message": "string"
      },
      "payment_tag": "string",
      "status_code": "string",
      "message": "string",
      "name": "string",
      "acquirer_transaction_id": "string",
      "authorization_code": "string",
      "transaction_id": "string",
      "reason_code": "string",
      "reason_message": "string",
      "merchant_advice_code": "string"
    }
  ],
  "combined_id": "string",
  "order_id": "string",
  "seller_id": "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.
  - `brand` (string)
    Brand.
  - `payment_id` (string)
    payment_id.
  - `seller_id` (string)
    seller_id.
  - `amount` (string)
    amount.
  - `currency` (string)
    currency.
  - `order_id` (string)
    order_id.
  - `credit_cancel` (object)
    credit_cancel.
    - `canceled_at` (string)
      canceledAt.
    - `message` (string)
      message.
  - `payment_tag` (string)
    payment_tag.
  - `status_code` (string)
    statusCode.
  - `message` (string)
    message.
  - `name` (string)
    name.
  - `acquirer_transaction_id` (string)
    acquirer_transaction_id.
  - `authorization_code` (string)
    authorization_code.
  - `transaction_id` (string)
    transaction_id.
  - `reason_code` (string)
    reason_code.
  - `reason_message` (string)
    reason_message.
  - `merchant_advice_code` (string)
    merchant_advice_code.
- `payments` (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.
  - `brand` (string)
    Brand.
  - `payment_id` (string)
    payment_id.
  - `seller_id` (string)
    seller_id.
  - `amount` (string)
    amount.
  - `currency` (string)
    currency.
  - `order_id` (string)
    order_id.
  - `credit_cancel` (object)
    credit_cancel.
    - `canceled_at` (string)
      canceledAt.
    - `message` (string)
      message.
  - `payment_tag` (string)
    payment_tag.
  - `status_code` (string)
    statusCode.
  - `message` (string)
    message.
  - `name` (string)
    name.
  - `acquirer_transaction_id` (string)
    acquirer_transaction_id.
  - `authorization_code` (string)
    authorization_code.
  - `transaction_id` (string)
    transaction_id.
  - `reason_code` (string)
    reason_code.
  - `reason_message` (string)
    reason_message.
  - `merchant_advice_code` (string)
    merchant_advice_code.
- `combined_id` (string)
  combinedId.
- `order_id` (string)
  orderId.
- `seller_id` (string)
  sellerId.

Example:

```json
{
  "message": "string",
  "name": "string",
  "status_code": 0,
  "details": [
    {
      "status": "string",
      "error_code": "string",
      "description": "string",
      "description_detail": "string",
      "brand": "string",
      "payment_id": "string",
      "seller_id": "string",
      "amount": "string",
      "currency": "string",
      "order_id": "string",
      "credit_cancel": {
        "canceled_at": "string",
        "message": "string"
      },
      "payment_tag": "string",
      "status_code": "string",
      "message": "string",
      "name": "string",
      "acquirer_transaction_id": "string",
      "authorization_code": "string",
      "transaction_id": "string",
      "reason_code": "string",
      "reason_message": "string",
      "merchant_advice_code": "string"
    }
  ],
  "payments": [
    {
      "status": "string",
      "error_code": "string",
      "description": "string",
      "description_detail": "string",
      "brand": "string",
      "payment_id": "string",
      "seller_id": "string",
      "amount": "string",
      "currency": "string",
      "order_id": "string",
      "credit_cancel": {
        "canceled_at": "string",
        "message": "string"
      },
      "payment_tag": "string",
      "status_code": "string",
      "message": "string",
      "name": "string",
      "acquirer_transaction_id": "string",
      "authorization_code": "string",
      "transaction_id": "string",
      "reason_code": "string",
      "reason_message": "string",
      "merchant_advice_code": "string"
    }
  ],
  "combined_id": "string",
  "order_id": "string",
  "seller_id": "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.
  - `brand` (string)
    Brand.
  - `payment_id` (string)
    payment_id.
  - `seller_id` (string)
    seller_id.
  - `amount` (string)
    amount.
  - `currency` (string)
    currency.
  - `order_id` (string)
    order_id.
  - `credit_cancel` (object)
    credit_cancel.
    - `canceled_at` (string)
      canceledAt.
    - `message` (string)
      message.
  - `payment_tag` (string)
    payment_tag.
  - `status_code` (string)
    statusCode.
  - `message` (string)
    message.
  - `name` (string)
    name.
  - `acquirer_transaction_id` (string)
    acquirer_transaction_id.
  - `authorization_code` (string)
    authorization_code.
  - `transaction_id` (string)
    transaction_id.
  - `reason_code` (string)
    reason_code.
  - `reason_message` (string)
    reason_message.
  - `merchant_advice_code` (string)
    merchant_advice_code.
- `payments` (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.
  - `brand` (string)
    Brand.
  - `payment_id` (string)
    payment_id.
  - `seller_id` (string)
    seller_id.
  - `amount` (string)
    amount.
  - `currency` (string)
    currency.
  - `order_id` (string)
    order_id.
  - `credit_cancel` (object)
    credit_cancel.
    - `canceled_at` (string)
      canceledAt.
    - `message` (string)
      message.
  - `payment_tag` (string)
    payment_tag.
  - `status_code` (string)
    statusCode.
  - `message` (string)
    message.
  - `name` (string)
    name.
  - `acquirer_transaction_id` (string)
    acquirer_transaction_id.
  - `authorization_code` (string)
    authorization_code.
  - `transaction_id` (string)
    transaction_id.
  - `reason_code` (string)
    reason_code.
  - `reason_message` (string)
    reason_message.
  - `merchant_advice_code` (string)
    merchant_advice_code.
- `combined_id` (string)
  combinedId.
- `order_id` (string)
  orderId.
- `seller_id` (string)
  sellerId.

Example:

```json
{
  "message": "string",
  "name": "string",
  "status_code": 0,
  "details": [
    {
      "status": "string",
      "error_code": "string",
      "description": "string",
      "description_detail": "string",
      "brand": "string",
      "payment_id": "string",
      "seller_id": "string",
      "amount": "string",
      "currency": "string",
      "order_id": "string",
      "credit_cancel": {
        "canceled_at": "string",
        "message": "string"
      },
      "payment_tag": "string",
      "status_code": "string",
      "message": "string",
      "name": "string",
      "acquirer_transaction_id": "string",
      "authorization_code": "string",
      "transaction_id": "string",
      "reason_code": "string",
      "reason_message": "string",
      "merchant_advice_code": "string"
    }
  ],
  "payments": [
    {
      "status": "string",
      "error_code": "string",
      "description": "string",
      "description_detail": "string",
      "brand": "string",
      "payment_id": "string",
      "seller_id": "string",
      "amount": "string",
      "currency": "string",
      "order_id": "string",
      "credit_cancel": {
        "canceled_at": "string",
        "message": "string"
      },
      "payment_tag": "string",
      "status_code": "string",
      "message": "string",
      "name": "string",
      "acquirer_transaction_id": "string",
      "authorization_code": "string",
      "transaction_id": "string",
      "reason_code": "string",
      "reason_message": "string",
      "merchant_advice_code": "string"
    }
  ],
  "combined_id": "string",
  "order_id": "string",
  "seller_id": "string"
}
```