Criar boleto

curl --request POST \
  --url https://api.alphagateway.com.br/v1/boleto/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "idempotency": "boleto-3001",
  "value": 150,
  "description": "Mensalidade de outubro",
  "payer": {
    "fullName": "Maria Oliveira Santos",
    "document": "12345678909",
    "address": {
      "street": "Rua das Flores",
      "number": "100",
      "complement": "Sala 2",
      "district": "Centro",
      "city": "Cuiabá",
      "state": "MT",
      "postalCode": "78005000"
    }
  },
  "dueDate": "2026-10-30"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    idempotency: 'boleto-3001',
    value: 150,
    description: 'Mensalidade de outubro',
    payer: {
      fullName: 'Maria Oliveira Santos',
      document: '12345678909',
      address: {
        street: 'Rua das Flores',
        number: '100',
        complement: 'Sala 2',
        district: 'Centro',
        city: 'Cuiabá',
        state: 'MT',
        postalCode: '78005000'
      }
    },
    dueDate: '2026-10-30'
  })
};

fetch('https://api.alphagateway.com.br/v1/boleto/create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.alphagateway.com.br/v1/boleto/create"

payload = {
    "idempotency": "boleto-3001",
    "value": 150,
    "description": "Mensalidade de outubro",
    "payer": {
        "fullName": "Maria Oliveira Santos",
        "document": "12345678909",
        "address": {
            "street": "Rua das Flores",
            "number": "100",
            "complement": "Sala 2",
            "district": "Centro",
            "city": "Cuiabá",
            "state": "MT",
            "postalCode": "78005000"
        }
    },
    "dueDate": "2026-10-30"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.alphagateway.com.br/v1/boleto/create",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'idempotency' => 'boleto-3001',
    'value' => 150,
    'description' => 'Mensalidade de outubro',
    'payer' => [
        'fullName' => 'Maria Oliveira Santos',
        'document' => '12345678909',
        'address' => [
                'street' => 'Rua das Flores',
                'number' => '100',
                'complement' => 'Sala 2',
                'district' => 'Centro',
                'city' => 'Cuiabá',
                'state' => 'MT',
                'postalCode' => '78005000'
        ]
    ],
    'dueDate' => '2026-10-30'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "message": "Boleto criado com sucesso!",
  "response": {
    "transactionId": "01961234-abcd-7000-8000-000000000003",
    "status": "CREATED",
    "idempotency": "boleto-3001",
    "valueRequested": 150,
    "valueFee": 2,
    "valueLiquid": 148,
    "barcode": "00190000090123456789012345678901234567890123",
    "linhaDigitavel": "00190.00009 01234.567890 12345.678901 2 34567890123456",
    "qrcode": "00020101021226870014br.gov.bcb.pix2565qrcode.exemplo.com.br/cob/7f3c9a1e5204000053039865406149.905802BR5913LOJA EXEMPLO6007CUIABA62070503***6304ABCD",
    "dueDate": "2026-10-30"
  }
}

{
  "response": null,
  "errors": [
    "O valor da transação deve ser maior ou igual a R$1,00"
  ]
}

{
  "response": null,
  "errors": [
    "API key inválida ou expirada"
  ]
}

{
  "response": null,
  "errors": [
    "Credencial não possui permissão para esta funcionalidade, ajuste o escopo da credencial."
  ]
}

{
  "response": null,
  "errors": [
    "Limite de requisições excedido"
  ]
}

{
  "response": null,
  "errors": [
    "Erro interno"
  ]
}

{
  "response": null,
  "errors": [
    "Este serviço está temporariamente indisponível devido a manutenção"
  ]
}

POST

boleto

create

Criar boleto

curl --request POST \
  --url https://api.alphagateway.com.br/v1/boleto/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "idempotency": "boleto-3001",
  "value": 150,
  "description": "Mensalidade de outubro",
  "payer": {
    "fullName": "Maria Oliveira Santos",
    "document": "12345678909",
    "address": {
      "street": "Rua das Flores",
      "number": "100",
      "complement": "Sala 2",
      "district": "Centro",
      "city": "Cuiabá",
      "state": "MT",
      "postalCode": "78005000"
    }
  },
  "dueDate": "2026-10-30"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    idempotency: 'boleto-3001',
    value: 150,
    description: 'Mensalidade de outubro',
    payer: {
      fullName: 'Maria Oliveira Santos',
      document: '12345678909',
      address: {
        street: 'Rua das Flores',
        number: '100',
        complement: 'Sala 2',
        district: 'Centro',
        city: 'Cuiabá',
        state: 'MT',
        postalCode: '78005000'
      }
    },
    dueDate: '2026-10-30'
  })
};

fetch('https://api.alphagateway.com.br/v1/boleto/create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.alphagateway.com.br/v1/boleto/create"

payload = {
    "idempotency": "boleto-3001",
    "value": 150,
    "description": "Mensalidade de outubro",
    "payer": {
        "fullName": "Maria Oliveira Santos",
        "document": "12345678909",
        "address": {
            "street": "Rua das Flores",
            "number": "100",
            "complement": "Sala 2",
            "district": "Centro",
            "city": "Cuiabá",
            "state": "MT",
            "postalCode": "78005000"
        }
    },
    "dueDate": "2026-10-30"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.alphagateway.com.br/v1/boleto/create",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'idempotency' => 'boleto-3001',
    'value' => 150,
    'description' => 'Mensalidade de outubro',
    'payer' => [
        'fullName' => 'Maria Oliveira Santos',
        'document' => '12345678909',
        'address' => [
                'street' => 'Rua das Flores',
                'number' => '100',
                'complement' => 'Sala 2',
                'district' => 'Centro',
                'city' => 'Cuiabá',
                'state' => 'MT',
                'postalCode' => '78005000'
        ]
    ],
    'dueDate' => '2026-10-30'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "message": "Boleto criado com sucesso!",
  "response": {
    "transactionId": "01961234-abcd-7000-8000-000000000003",
    "status": "CREATED",
    "idempotency": "boleto-3001",
    "valueRequested": 150,
    "valueFee": 2,
    "valueLiquid": 148,
    "barcode": "00190000090123456789012345678901234567890123",
    "linhaDigitavel": "00190.00009 01234.567890 12345.678901 2 34567890123456",
    "qrcode": "00020101021226870014br.gov.bcb.pix2565qrcode.exemplo.com.br/cob/7f3c9a1e5204000053039865406149.905802BR5913LOJA EXEMPLO6007CUIABA62070503***6304ABCD",
    "dueDate": "2026-10-30"
  }
}

{
  "response": null,
  "errors": [
    "O valor da transação deve ser maior ou igual a R$1,00"
  ]
}

{
  "response": null,
  "errors": [
    "API key inválida ou expirada"
  ]
}

{
  "response": null,
  "errors": [
    "Credencial não possui permissão para esta funcionalidade, ajuste o escopo da credencial."
  ]
}

{
  "response": null,
  "errors": [
    "Limite de requisições excedido"
  ]
}

{
  "response": null,
  "errors": [
    "Erro interno"
  ]
}

{
  "response": null,
  "errors": [
    "Este serviço está temporariamente indisponível devido a manutenção"
  ]
}

Autorizações

x-api-key

string

header

obrigatório

API Key da organização

Corpo

application/json

idempotency

string

obrigatório

Identificador único do boleto por organização. Garante que o mesmo boleto não seja emitido duas vezes.

Minimum string length: 1

value

number

obrigatório

Valor do boleto em reais (ex.: 150.00). Deve ser positivo e maior ou igual a R$ 3,00.

Intervalo obrigatório: x >= 3

payer

object

obrigatório

Dados do pagador do boleto.

Show child attributes

description

string

Descrição opcional do boleto (máximo 100 caracteres).

Maximum string length: 100

dueDate

string

Data de vencimento do boleto no formato YYYY-MM-DD (opcional; usa o padrão da organização se omitida).

Pattern: ^\d{4}-\d{2}-\d{2}$

expirationDate

string

Data limite para pagamento após o vencimento, no formato YYYY-MM-DD (opcional).

Pattern: ^\d{4}-\d{2}-\d{2}$

boletoType

enum<string>

Tipo do boleto: OTHER (padrão) ou PROPOSAL.

Opções disponíveis:

OTHER,

PROPOSAL

Resposta

Requisição processada com sucesso

response

object

obrigatório

Dados retornados pela operação; null quando não há conteúdo.

Show child attributes

message

string

obrigatório

Mensagem que descreve o resultado.