Criar link de pagamento

curl --request POST \
  --url https://api.alphagateway.com.br/v1/payment-links/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "products": [
    {
      "externalId": "plano-mensal",
      "quantity": 1
    },
    {
      "name": "Taxa de adesão",
      "value": 19.9
    }
  ],
  "paymentMethods": [
    "PIX_IN",
    "BOLETO"
  ],
  "customer": {
    "fullName": "Maria Oliveira Santos",
    "document": "12345678909",
    "email": "maria@exemplo.com.br",
    "phone": "65999998888"
  },
  "idempotency": "link-4001",
  "callbackOnSuccess": "https://loja.exemplo.com.br/obrigado",
  "paymentLimit": 1
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    products: [
      {externalId: 'plano-mensal', quantity: 1},
      {name: 'Taxa de adesão', value: 19.9}
    ],
    paymentMethods: ['PIX_IN', 'BOLETO'],
    customer: {
      fullName: 'Maria Oliveira Santos',
      document: '12345678909',
      email: 'maria@exemplo.com.br',
      phone: '65999998888'
    },
    idempotency: 'link-4001',
    callbackOnSuccess: 'https://loja.exemplo.com.br/obrigado',
    paymentLimit: 1
  })
};

fetch('https://api.alphagateway.com.br/v1/payment-links/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/payment-links/create"

payload = {
    "products": [
        {
            "externalId": "plano-mensal",
            "quantity": 1
        },
        {
            "name": "Taxa de adesão",
            "value": 19.9
        }
    ],
    "paymentMethods": ["PIX_IN", "BOLETO"],
    "customer": {
        "fullName": "Maria Oliveira Santos",
        "document": "12345678909",
        "email": "maria@exemplo.com.br",
        "phone": "65999998888"
    },
    "idempotency": "link-4001",
    "callbackOnSuccess": "https://loja.exemplo.com.br/obrigado",
    "paymentLimit": 1
}
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/payment-links/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([
    'products' => [
        [
                'externalId' => 'plano-mensal',
                'quantity' => 1
        ],
        [
                'name' => 'Taxa de adesão',
                'value' => 19.9
        ]
    ],
    'paymentMethods' => [
        'PIX_IN',
        'BOLETO'
    ],
    'customer' => [
        'fullName' => 'Maria Oliveira Santos',
        'document' => '12345678909',
        'email' => 'maria@exemplo.com.br',
        'phone' => '65999998888'
    ],
    'idempotency' => 'link-4001',
    'callbackOnSuccess' => 'https://loja.exemplo.com.br/obrigado',
    'paymentLimit' => 1
  ]),
  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": "Link de pagamento criado com sucesso",
  "response": {
    "id": "01961234-abcd-7000-8000-000000000004",
    "token": "k7Qm2xPz",
    "status": "ACTIVE",
    "idempotency": "link-4001",
    "paymentMethods": [
      "PIX_IN",
      "BOLETO"
    ],
    "recurrent": false,
    "url": "https://painel.alphagateway.com.br/payment/checkout/k7Qm2xPz"
  }
}

{
  "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": [
    "Transação não encontrada"
  ]
}

{
  "response": null,
  "errors": [
    "Já existe um link de pagamento com este idempotency"
  ]
}

{
  "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

payment-links

create

Criar link de pagamento

curl --request POST \
  --url https://api.alphagateway.com.br/v1/payment-links/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "products": [
    {
      "externalId": "plano-mensal",
      "quantity": 1
    },
    {
      "name": "Taxa de adesão",
      "value": 19.9
    }
  ],
  "paymentMethods": [
    "PIX_IN",
    "BOLETO"
  ],
  "customer": {
    "fullName": "Maria Oliveira Santos",
    "document": "12345678909",
    "email": "maria@exemplo.com.br",
    "phone": "65999998888"
  },
  "idempotency": "link-4001",
  "callbackOnSuccess": "https://loja.exemplo.com.br/obrigado",
  "paymentLimit": 1
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    products: [
      {externalId: 'plano-mensal', quantity: 1},
      {name: 'Taxa de adesão', value: 19.9}
    ],
    paymentMethods: ['PIX_IN', 'BOLETO'],
    customer: {
      fullName: 'Maria Oliveira Santos',
      document: '12345678909',
      email: 'maria@exemplo.com.br',
      phone: '65999998888'
    },
    idempotency: 'link-4001',
    callbackOnSuccess: 'https://loja.exemplo.com.br/obrigado',
    paymentLimit: 1
  })
};

fetch('https://api.alphagateway.com.br/v1/payment-links/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/payment-links/create"

payload = {
    "products": [
        {
            "externalId": "plano-mensal",
            "quantity": 1
        },
        {
            "name": "Taxa de adesão",
            "value": 19.9
        }
    ],
    "paymentMethods": ["PIX_IN", "BOLETO"],
    "customer": {
        "fullName": "Maria Oliveira Santos",
        "document": "12345678909",
        "email": "maria@exemplo.com.br",
        "phone": "65999998888"
    },
    "idempotency": "link-4001",
    "callbackOnSuccess": "https://loja.exemplo.com.br/obrigado",
    "paymentLimit": 1
}
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/payment-links/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([
    'products' => [
        [
                'externalId' => 'plano-mensal',
                'quantity' => 1
        ],
        [
                'name' => 'Taxa de adesão',
                'value' => 19.9
        ]
    ],
    'paymentMethods' => [
        'PIX_IN',
        'BOLETO'
    ],
    'customer' => [
        'fullName' => 'Maria Oliveira Santos',
        'document' => '12345678909',
        'email' => 'maria@exemplo.com.br',
        'phone' => '65999998888'
    ],
    'idempotency' => 'link-4001',
    'callbackOnSuccess' => 'https://loja.exemplo.com.br/obrigado',
    'paymentLimit' => 1
  ]),
  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": "Link de pagamento criado com sucesso",
  "response": {
    "id": "01961234-abcd-7000-8000-000000000004",
    "token": "k7Qm2xPz",
    "status": "ACTIVE",
    "idempotency": "link-4001",
    "paymentMethods": [
      "PIX_IN",
      "BOLETO"
    ],
    "recurrent": false,
    "url": "https://painel.alphagateway.com.br/payment/checkout/k7Qm2xPz"
  }
}

{
  "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": [
    "Transação não encontrada"
  ]
}

{
  "response": null,
  "errors": [
    "Já existe um link de pagamento com este idempotency"
  ]
}

{
  "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

products

object[]

obrigatório

Lista de produtos do link (mínimo 1). Cada item pode ser um produto existente (via externalId) ou um produto inline (via name e value).

Minimum array length: 1

Option 1
Option 2

Show child attributes

paymentMethods

enum<string>[]

obrigatório

Métodos de pagamento aceitos pelo link (mínimo 1).

Minimum array length: 1

Opções disponíveis:

PIX_IN,

CARD,

BOLETO

customer

object

Cliente vinculado ao link (opcional). Quando informado (fullName e document), os dados já vêm preenchidos na página de checkout.

Show child attributes

idempotency

string

Identificador único por organização. Evita criar o mesmo link duas vezes; uma segunda chamada com o mesmo valor retorna erro 409.

Minimum string length: 1

callbackOnSuccess

string<uri>

URL para redirecionar o pagador após o pagamento ser confirmado.

callbackOnError

string<uri>

URL para redirecionar o pagador em caso de erro ou cancelamento.

paymentLimit

integer

Número máximo de pagamentos aceitos pelo link. Use 0 ou omita para não limitar (ilimitado).

Intervalo obrigatório: x >= 0

recurrent

boolean

Habilita a recorrência: o pagamento com cartão salva o token do cartão para cobranças automáticas futuras. Exige CARD em paymentMethods.

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.