Create an Invoice/Boleto - Regional API GetNet

Generate Payment with Boleto

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.

Notes:

The boleto must include an expiration date, after which payment is no longer valid.

Once generated, the boleto cannot be modified; a new one must be issued if changes are required.

Payment confirmation times vary depending on the bank’s processing policies.

请求参数

Authorization

OAuth 2.0

Client Credentials

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Token URL: https://api.globalgetnet.com/authentication/oauth2/access_token

OAuth 2.0

Client Credentials

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Token URL: https://api.pre.globalgetnet.com/authentication/oauth2/access_token

OAuth 2.0

Client Credentials

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Token URL: https://api-sbx.globalgetnet.com/authentication/oauth2/access_token

Scopes:

digital-platform:gateway-api-Read and write access

Body 参数application/json必填

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/dpm/payments-gwproxy/v2/payments/boleto' \
--header 'Content-Type: application/json' \
--data-raw '{
    "idempotency_key": "63c7f8ee-51a6-470d-bb76-ef762b62bfb7",
    "request_id": "daac03dc-73db-453f-9bea-b1391669d5d3",
    "seller_id": "9406df6c-3100-49ba-b4df-d81c1ad8a62b",
    "amount": 8900,
    "order": {
        "order_id": "6d2e4380-d8a3-4ccb-9138-c289182818a3",
        "sales_tax": 12,
        "product_type": "cash_carry"
    },
    "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": "1946598.0",
        "document_number": "170500000019763",
        "expiration_date": "16/11/2030",
        "instructions": "Do not receive after expiration",
        "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": "CPF",
                    "document_number": "12345678912",
                    "subseller_sale_amount": 118708,
                    "items": [
                        {
                            "id": "MR1",
                            "description": "Product MR1.",
                            "amount": 118708,
                            "transaction_rate_percent": 1.2,
                            "transaction_rate_amount": 235,
                            "payment_plan": 3
                        }
                    ]
                }
            ]
        }
    }
}'

返回响应

🟢201

application/json

Created

Bodyapplication/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": "PENDING",
    "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

🟠404

🔴500