Referência da API

POST

/api/auth

Obter token de acesso · authenticate Basic

Respostas

HTTP	Descrição
200	Token emitido.
400	Requisição inválida ou regra de negócio violada.
401	Token ausente/inválido/expirado, ou credenciais incorretas.
429	Limite de requisições excedido. Aguarde `Retry-After` segundos.

Campos da resposta de sucesso

Campo	Tipo	Descrição
success	object
success.token	string
success.token_type	string
success.expires_in	integer	Validade em segundos (PASSPORT_TOKEN_DAYS, padrão 30 dias).

Exemplo · Obter token de acesso

#!/usr/bin/env bash
# Obter token de acesso (chave pública + chave secreta em HTTP Basic)
set -euo pipefail
: "${SHARKPAY_BASE_URL:?}" "${SHARKPAY_PUBLIC_KEY:?}" "${SHARKPAY_SECRET_KEY:?}"
curl -sS --fail-with-body -X POST "$SHARKPAY_BASE_URL/api/auth" \
  -u "$SHARKPAY_PUBLIC_KEY:$SHARKPAY_SECRET_KEY"
echo

// Obter token de acesso — Node.js 18+
const basic = Buffer.from(`${process.env.SHARKPAY_PUBLIC_KEY}:${process.env.SHARKPAY_SECRET_KEY}`).toString('base64');

const res = await fetch(`${process.env.SHARKPAY_BASE_URL}/api/auth`, {
  method: 'POST',
  headers: { Authorization: `Basic ${basic}` },
  signal: AbortSignal.timeout(30_000),
});
const data = await res.json().catch(() => ({}));
if (!res.ok) { console.error(res.status, data); process.exit(1); }

// Guarde o token em memória/cofre e renove ao expirar (expires_in, em segundos).
console.log(JSON.stringify(data.success, null, 2));

# Obter token de acesso — Python 3.9+ (pip install requests)
import os, sys
import requests

res = requests.post(
    os.environ["SHARKPAY_BASE_URL"] + "/api/auth",
    auth=(os.environ["SHARKPAY_PUBLIC_KEY"], os.environ["SHARKPAY_SECRET_KEY"]),  # HTTP Basic
    timeout=30,
)
data = res.json() if res.content else {}
print(res.status_code, data)
sys.exit(0 if res.ok else 1)

<?php
// Obter token de acesso — PHP 8+ com ext-curl
$ch = curl_init(getenv('SHARKPAY_BASE_URL') . '/api/auth');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_USERPWD => getenv('SHARKPAY_PUBLIC_KEY') . ':' . getenv('SHARKPAY_SECRET_KEY'), // HTTP Basic
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, ' ', $response, PHP_EOL;
exit($status === 200 ? 0 : 1);

GET

/api/invoices

Listar cobranças · listInvoices Bearer

Parâmetros

Nome	Em	Tipo	Descrição
page	query	integer (≥ 1)
limit	query	integer (≥ 1, ≤ 50)
invoice_no	query	string	Busca parcial pelo número informado na criação.
email	query	string	Busca parcial por e-mail.
start_date	query	string (date)	Use junto com end_date.
end_date	query	string (date)

Respostas

HTTP	Descrição
200	Página de cobranças (somente as suas).
401	Token ausente/inválido/expirado, ou credenciais incorretas.
422	Campos inválidos.

Campos da resposta de sucesso

Campo	Tipo	Descrição
invoices	array<object>
invoices[].id	integer
invoices[].ref_id	string
invoices[].invoice_no	string
invoices[].email	string
invoices[].due_date	string \| null
invoices[].item	string
invoices[].notes	string \| null
invoices[].quantity	integer
invoices[].amount	string
invoices[].tax	string	Valor do imposto em moeda.
invoices[].discount	string	Valor do desconto em moeda.
invoices[].charge	string
invoices[].total	string
invoices[].currency	string \| null
invoices[].status	string (PENDING, PAID, CANCELED, REFUNDED)
invoices[].created_at	string
invoices[].updated_at	string
invoices[].boleto	object
invoices[].pix	object
invoices[].customer	object
invoices[].customer.id	integer
invoices[].customer.name	string
invoices[].customer.document	string
invoices[].customer.document_type	string
invoices[].customer.zipcode	string
invoices[].customer.country	object
invoices[].customer.state	object
invoices[].customer.city	string
invoices[].customer.district	string
invoices[].customer.street	string
invoices[].customer.number	string
invoices[].customer.email	string
invoices[].customer.phone	string
invoices[].customer.mobilephone	string
invoices[].transactions	array<object>
pagination	object
pagination.page	integer
pagination.limit	integer

Exemplo · Listar cobranças

#!/usr/bin/env bash
# Listar cobranças
set -euo pipefail
: "${SHARKPAY_BASE_URL:?defina a URL base, ex.: https://pay.exemplo.com}"
: "${SHARKPAY_TOKEN:?obtenha o token com o exemplo "auth"}"
curl -sS --fail-with-body -X GET "$SHARKPAY_BASE_URL/api/invoices?page=1&limit=10" \
  -H "Authorization: Bearer $SHARKPAY_TOKEN"
echo

// Listar cobranças — Node.js 18+ (fetch nativo, sem dependências)
import { randomUUID } from 'node:crypto';

const BASE = process.env.SHARKPAY_BASE_URL;
const TOKEN = process.env.SHARKPAY_TOKEN;

const headers = { Authorization: `Bearer ${TOKEN}` };
const res = await fetch(`${BASE}/api/invoices?page=1&limit=10`, {
  method: 'GET',
  headers,
  signal: AbortSignal.timeout(30_000), // sempre defina um timeout
});
const data = await res.json().catch(() => ({}));
console.log(res.status, JSON.stringify(data, null, 2));
if (!res.ok) process.exit(1);

# Listar cobranças — Python 3.9+ (pip install requests)
import os, sys, uuid
import requests

BASE = os.environ["SHARKPAY_BASE_URL"]
TOKEN = os.environ["SHARKPAY_TOKEN"]

headers = {"Authorization": f"Bearer {TOKEN}"}
res = requests.get(BASE + "/api/invoices", headers=headers, params={"page": 1, "limit": 10}, timeout=30)
try:
    data = res.json()
except ValueError:
    data = {}
print(res.status_code, data)
sys.exit(0 if res.ok else 1)

<?php
// Listar cobranças — PHP 8+ com ext-curl

$base  = getenv("SHARKPAY_BASE_URL");
$token = getenv("SHARKPAY_TOKEN");

$ch = curl_init($base . '/api/invoices?page=1&limit=10');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 30, // sempre defina um timeout
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer $token",
    ],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, " ", $response, PHP_EOL;
exit($status >= 200 && $status < 300 ? 0 : 1);

GET

/api/invoice/{invoice_id}

Consultar cobrança pelo id numérico · getInvoice Bearer

Parâmetros

Nome	Em	Tipo	Descrição
invoice_idobrigatório	path	integer

Respostas

HTTP	Descrição
200	Cobrança.
401	Token ausente/inválido/expirado, ou credenciais incorretas.
404	Não encontrado (ou pertence a outra conta).

Campos da resposta de sucesso

Campo	Tipo	Descrição
invoice	object
invoice.id	integer
invoice.ref_id	string
invoice.invoice_no	string
invoice.email	string
invoice.due_date	string \| null
invoice.item	string
invoice.notes	string \| null
invoice.quantity	integer
invoice.amount	string
invoice.tax	string	Valor do imposto em moeda.
invoice.discount	string	Valor do desconto em moeda.
invoice.charge	string
invoice.total	string
invoice.currency	string \| null
invoice.status	string (PENDING, PAID, CANCELED, REFUNDED)
invoice.created_at	string
invoice.updated_at	string
invoice.boleto	object
invoice.pix	object
invoice.customer	object
invoice.customer.id	integer
invoice.customer.name	string
invoice.customer.document	string
invoice.customer.document_type	string
invoice.customer.zipcode	string
invoice.customer.country	object
invoice.customer.state	object
invoice.customer.city	string
invoice.customer.district	string
invoice.customer.street	string
invoice.customer.number	string
invoice.customer.email	string
invoice.customer.phone	string
invoice.customer.mobilephone	string
invoice.transactions	array<object>

GET

/api/invoice/ref/{ref_id}

Consultar cobrança pela referência (INV-xxxxxx) · getInvoiceByRef Bearer

Parâmetros

Nome	Em	Tipo	Descrição
ref_idobrigatório	path	string

Respostas

HTTP	Descrição
200	Cobrança.
401	Token ausente/inválido/expirado, ou credenciais incorretas.
404	Não encontrado (ou pertence a outra conta).

Campos da resposta de sucesso

Campo	Tipo	Descrição
invoice	object
invoice.id	integer
invoice.ref_id	string
invoice.invoice_no	string
invoice.email	string
invoice.due_date	string \| null
invoice.item	string
invoice.notes	string \| null
invoice.quantity	integer
invoice.amount	string
invoice.tax	string	Valor do imposto em moeda.
invoice.discount	string	Valor do desconto em moeda.
invoice.charge	string
invoice.total	string
invoice.currency	string \| null
invoice.status	string (PENDING, PAID, CANCELED, REFUNDED)
invoice.created_at	string
invoice.updated_at	string
invoice.boleto	object
invoice.pix	object
invoice.customer	object
invoice.customer.id	integer
invoice.customer.name	string
invoice.customer.document	string
invoice.customer.document_type	string
invoice.customer.zipcode	string
invoice.customer.country	object
invoice.customer.state	object
invoice.customer.city	string
invoice.customer.district	string
invoice.customer.street	string
invoice.customer.number	string
invoice.customer.email	string
invoice.customer.phone	string
invoice.customer.mobilephone	string
invoice.transactions	array<object>

Exemplo · Consultar cobrança pela referência (INV-xxxxxx)

#!/usr/bin/env bash
# Consultar cobrança pela referência
set -euo pipefail
: "${SHARKPAY_BASE_URL:?defina a URL base, ex.: https://pay.exemplo.com}"
: "${SHARKPAY_TOKEN:?obtenha o token com o exemplo "auth"}"
curl -sS --fail-with-body -X GET "$SHARKPAY_BASE_URL/api/invoice/ref/$SHARKPAY_REF" \
  -H "Authorization: Bearer $SHARKPAY_TOKEN"
echo

// Consultar cobrança pela referência — Node.js 18+ (fetch nativo, sem dependências)
import { randomUUID } from 'node:crypto';

const BASE = process.env.SHARKPAY_BASE_URL;
const TOKEN = process.env.SHARKPAY_TOKEN;

const headers = { Authorization: `Bearer ${TOKEN}` };
const res = await fetch(`${BASE}/api/invoice/ref/${process.env.SHARKPAY_REF}`, {
  method: 'GET',
  headers,
  signal: AbortSignal.timeout(30_000), // sempre defina um timeout
});
const data = await res.json().catch(() => ({}));
console.log(res.status, JSON.stringify(data, null, 2));
if (!res.ok) process.exit(1);

# Consultar cobrança pela referência — Python 3.9+ (pip install requests)
import os, sys, uuid
import requests

BASE = os.environ["SHARKPAY_BASE_URL"]
TOKEN = os.environ["SHARKPAY_TOKEN"]

headers = {"Authorization": f"Bearer {TOKEN}"}
res = requests.get(BASE + "/api/invoice/ref/" + os.environ["SHARKPAY_REF"] + "", headers=headers, timeout=30)
try:
    data = res.json()
except ValueError:
    data = {}
print(res.status_code, data)
sys.exit(0 if res.ok else 1)

<?php
// Consultar cobrança pela referência — PHP 8+ com ext-curl

$base  = getenv("SHARKPAY_BASE_URL");
$token = getenv("SHARKPAY_TOKEN");

$ch = curl_init($base . '/api/invoice/ref/' . getenv('SHARKPAY_REF'));
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 30, // sempre defina um timeout
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer $token",
    ],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, " ", $response, PHP_EOL;
exit($status >= 200 && $status < 300 ? 0 : 1);

POST

/api/creditcard/create

Cobrar cartão de crédito · createCreditcardCharge Bearer

Cria a cobrança e tenta autorizar na hora. Os dados do cartão passam pelo seu servidor e pelo SharkPay:
isso traz obrigações PCI DSS para quem os coleta. Nunca registre número/CVV em logs.
Requer o método "cartão" habilitado para a conta. total = amount × quantity + imposto% − desconto%.

Parâmetros

Nome	Em	Tipo	Descrição
Idempotency-Key	header	string (mín. 8, máx. 100)	Recomendado. 8–100 caracteres `A-Za-z0-9_.:-`.

Corpo (JSON)

Campo	Tipo	Descrição
amountobrigatório	number (≤ 999999999, > 0)	Valor unitário.
quantityobrigatório	integer (≥ 1, ≤ 100000)
discountobrigatório	number (≥ 0, ≤ 100)	Desconto em %.
taxobrigatório	number (≥ 0, ≤ 100)	Imposto em %.
invoice_noobrigatório	string (máx. 100)
due_dateobrigatório	string (date)
item_nameobrigatório	string (máx. 255)
notesopcional	string (máx. 500)
emailobrigatório	string (email)
installmentsobrigatório	integer (≥ 1, ≤ 24)
creditcard_holderobrigatório	string
creditcard_numberobrigatório	string
creditcard_cvvobrigatório	string
creditcard_monthobrigatório	integer (≥ 1, ≤ 12)
creditcard_yearobrigatório	integer	4 dígitos.
creditcard_brandobrigatório	string

Respostas

HTTP	Descrição
200	Pagamento aprovado.
400	Requisição inválida ou regra de negócio violada.
401	Token ausente/inválido/expirado, ou credenciais incorretas.
409	A mesma Idempotency-Key ainda está em processamento.
422	Campos inválidos.
500	Falha inesperada. Seguro repetir com a mesma Idempotency-Key.

Campos da resposta de sucesso

Campo	Tipo	Descrição
invoice	object
invoice.reference	string
invoice.total	string
invoice.due_date	string
invoice.status	string (PENDING, PAID, CANCELED, REFUNDED)
invoice.transaction	object
invoice.transaction.id	string
invoice.transaction.amount	string
invoice.transaction.status	integer
invoice.transaction.description	string
invoice.transaction.method	string

Exemplo · Cobrar cartão de crédito

#!/usr/bin/env bash
# Cobrar cartão de crédito
set -euo pipefail
: "${SHARKPAY_BASE_URL:?defina a URL base, ex.: https://pay.exemplo.com}"
: "${SHARKPAY_TOKEN:?obtenha o token com o exemplo "auth"}"
DUE=$(date -d "+7 days" +%F 2>/dev/null || date -v+7d +%F)  # vencimento daqui a 7 dias
curl -sS --fail-with-body -X POST "$SHARKPAY_BASE_URL/api/creditcard/create" \
  -H "Authorization: Bearer $SHARKPAY_TOKEN" \
  -H "Idempotency-Key: ${IDEMPOTENCY_KEY:-$(uuidgen)}" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 100,
  "quantity": 1,
  "discount": 0,
  "tax": 0,
  "installments": 3,
  "invoice_no": "PED-1003",
  "due_date": "'"$DUE"'",
  "item_name": "Assinatura",
  "email": "maria@example.com",
  "creditcard_holder": "MARIA SOUZA",
  "creditcard_number": "4111111111111111",
  "creditcard_cvv": "123",
  "creditcard_month": 12,
  "creditcard_year": 2030,
  "creditcard_brand": "Visa"
}'
echo

// Cobrar cartão de crédito — Node.js 18+ (fetch nativo, sem dependências)
import { randomUUID } from 'node:crypto';

const BASE = process.env.SHARKPAY_BASE_URL;
const TOKEN = process.env.SHARKPAY_TOKEN;
const dueDate = new Date(Date.now() + 7 * 864e5).toISOString().slice(0, 10); // vencimento em 7 dias

const body = {
  amount: 100,
  quantity: 1,
  discount: 0,
  tax: 0,
  installments: 3,
  invoice_no: "PED-1003",
  due_date: dueDate,
  item_name: "Assinatura",
  email: "maria@example.com",
  creditcard_holder: "MARIA SOUZA",
  creditcard_number: "4111111111111111",
  creditcard_cvv: "123",
  creditcard_month: 12,
  creditcard_year: 2030,
  creditcard_brand: "Visa",
};

const headers = { Authorization: `Bearer ${TOKEN}` };
headers['Content-Type'] = 'application/json';
headers['Idempotency-Key'] = process.env.IDEMPOTENCY_KEY ?? randomUUID(); // reutilize a MESMA chave ao repetir a operação
const res = await fetch(`${BASE}/api/creditcard/create`, {
  method: 'POST',
  headers,
  body: JSON.stringify(body),
  signal: AbortSignal.timeout(30_000), // sempre defina um timeout
});
const data = await res.json().catch(() => ({}));
console.log(res.status, JSON.stringify(data, null, 2));
if (!res.ok) process.exit(1);

# Cobrar cartão de crédito — Python 3.9+ (pip install requests)
import os, sys, uuid
from datetime import date, timedelta
import requests

BASE = os.environ["SHARKPAY_BASE_URL"]
TOKEN = os.environ["SHARKPAY_TOKEN"]
due_date = (date.today() + timedelta(days=7)).isoformat()  # vencimento em 7 dias

body = {
    "amount": 100,
    "quantity": 1,
    "discount": 0,
    "tax": 0,
    "installments": 3,
    "invoice_no": "PED-1003",
    "due_date": due_date,
    "item_name": "Assinatura",
    "email": "maria@example.com",
    "creditcard_holder": "MARIA SOUZA",
    "creditcard_number": "4111111111111111",
    "creditcard_cvv": "123",
    "creditcard_month": 12,
    "creditcard_year": 2030,
    "creditcard_brand": "Visa",
}

headers = {"Authorization": f"Bearer {TOKEN}"}
headers["Idempotency-Key"] = os.environ.get("IDEMPOTENCY_KEY", str(uuid.uuid4()))  # reutilize a MESMA chave ao repetir
res = requests.post(BASE + "/api/creditcard/create", headers=headers, json=body, timeout=30)
try:
    data = res.json()
except ValueError:
    data = {}
print(res.status_code, data)
sys.exit(0 if res.ok else 1)

<?php
// Cobrar cartão de crédito — PHP 8+ com ext-curl

$base  = getenv("SHARKPAY_BASE_URL");
$token = getenv("SHARKPAY_TOKEN");
$dueDate = date('Y-m-d', strtotime('+7 days')); // vencimento em 7 dias

$body = [
    'amount' => 100,
    'quantity' => 1,
    'discount' => 0,
    'tax' => 0,
    'installments' => 3,
    'invoice_no' => 'PED-1003',
    'due_date' => $dueDate,
    'item_name' => 'Assinatura',
    'email' => 'maria@example.com',
    'creditcard_holder' => 'MARIA SOUZA',
    'creditcard_number' => '4111111111111111',
    'creditcard_cvv' => '123',
    'creditcard_month' => 12,
    'creditcard_year' => 2030,
    'creditcard_brand' => 'Visa',
];

$ch = curl_init($base . '/api/creditcard/create');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 30, // sempre defina um timeout
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer $token",
        "Content-Type: application/json",
        "Idempotency-Key: " . (getenv("IDEMPOTENCY_KEY") ?: bin2hex(random_bytes(16))), // reutilize a MESMA chave ao repetir
    ],
    CURLOPT_POSTFIELDS => json_encode($body),
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, " ", $response, PHP_EOL;
exit($status >= 200 && $status < 300 ? 0 : 1);

POST

/api/boleto/create

Emitir boleto · createBoleto Bearer

Requer o método "boleto" habilitado e um cliente já cadastrado (POST /api/customer).

Parâmetros

Nome	Em	Tipo	Descrição
Idempotency-Key	header	string (mín. 8, máx. 100)	Recomendado. 8–100 caracteres `A-Za-z0-9_.:-`.

Corpo (JSON)

Campo	Tipo	Descrição
amountobrigatório	number (≤ 999999999, > 0)	Valor unitário.
quantityobrigatório	integer (≥ 1, ≤ 100000)
discountobrigatório	number (≥ 0, ≤ 100)	Desconto em %.
taxopcional	number (≥ 0, ≤ 100)	Imposto em %.
invoice_noobrigatório	string (máx. 100)
due_dateobrigatório	string (date)
item_nameobrigatório	string (máx. 255)
notesopcional	string (máx. 500)
customerobrigatório	integer	Id de um cliente seu (POST /api/customer).
instructionsopcional	string (máx. 255)

Respostas

HTTP	Descrição
200	Boleto emitido.
400	Requisição inválida ou regra de negócio violada.
401	Token ausente/inválido/expirado, ou credenciais incorretas.
409	A mesma Idempotency-Key ainda está em processamento.
422	Campos inválidos.
500	Falha inesperada. Seguro repetir com a mesma Idempotency-Key.

Campos da resposta de sucesso

Campo	Tipo	Descrição
invoice	object
invoice.reference	string
invoice.total	string \| number
invoice.due_date	string (date)
invoice.status	string (PENDING, PAID, CANCELED, REFUNDED)
invoice.boleto	string	URL do boleto.
invoice.barcode	string
invoice.digitable	string

Exemplo · Emitir boleto

#!/usr/bin/env bash
# Emitir boleto
set -euo pipefail
: "${SHARKPAY_BASE_URL:?defina a URL base, ex.: https://pay.exemplo.com}"
: "${SHARKPAY_TOKEN:?obtenha o token com o exemplo "auth"}"
DUE=$(date -d "+7 days" +%F 2>/dev/null || date -v+7d +%F)  # vencimento daqui a 7 dias
curl -sS --fail-with-body -X POST "$SHARKPAY_BASE_URL/api/boleto/create" \
  -H "Authorization: Bearer $SHARKPAY_TOKEN" \
  -H "Idempotency-Key: ${IDEMPOTENCY_KEY:-$(uuidgen)}" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 150,
  "quantity": 1,
  "discount": 0,
  "tax": 0,
  "invoice_no": "PED-1002",
  "due_date": "'"$DUE"'",
  "item_name": "Plano anual",
  "customer": '"$SHARKPAY_CUSTOMER_ID"',
  "instructions": "Não receber após o vencimento"
}'
echo

// Emitir boleto — Node.js 18+ (fetch nativo, sem dependências)
import { randomUUID } from 'node:crypto';

const BASE = process.env.SHARKPAY_BASE_URL;
const TOKEN = process.env.SHARKPAY_TOKEN;
const dueDate = new Date(Date.now() + 7 * 864e5).toISOString().slice(0, 10); // vencimento em 7 dias

const body = {
  amount: 150,
  quantity: 1,
  discount: 0,
  tax: 0,
  invoice_no: "PED-1002",
  due_date: dueDate,
  item_name: "Plano anual",
  customer: Number(process.env.SHARKPAY_CUSTOMER_ID),
  instructions: "Não receber após o vencimento",
};

const headers = { Authorization: `Bearer ${TOKEN}` };
headers['Content-Type'] = 'application/json';
headers['Idempotency-Key'] = process.env.IDEMPOTENCY_KEY ?? randomUUID(); // reutilize a MESMA chave ao repetir a operação
const res = await fetch(`${BASE}/api/boleto/create`, {
  method: 'POST',
  headers,
  body: JSON.stringify(body),
  signal: AbortSignal.timeout(30_000), // sempre defina um timeout
});
const data = await res.json().catch(() => ({}));
console.log(res.status, JSON.stringify(data, null, 2));
if (!res.ok) process.exit(1);

# Emitir boleto — Python 3.9+ (pip install requests)
import os, sys, uuid
from datetime import date, timedelta
import requests

BASE = os.environ["SHARKPAY_BASE_URL"]
TOKEN = os.environ["SHARKPAY_TOKEN"]
due_date = (date.today() + timedelta(days=7)).isoformat()  # vencimento em 7 dias

body = {
    "amount": 150,
    "quantity": 1,
    "discount": 0,
    "tax": 0,
    "invoice_no": "PED-1002",
    "due_date": due_date,
    "item_name": "Plano anual",
    "customer": int(os.environ["SHARKPAY_CUSTOMER_ID"]),
    "instructions": "Não receber após o vencimento",
}

headers = {"Authorization": f"Bearer {TOKEN}"}
headers["Idempotency-Key"] = os.environ.get("IDEMPOTENCY_KEY", str(uuid.uuid4()))  # reutilize a MESMA chave ao repetir
res = requests.post(BASE + "/api/boleto/create", headers=headers, json=body, timeout=30)
try:
    data = res.json()
except ValueError:
    data = {}
print(res.status_code, data)
sys.exit(0 if res.ok else 1)

<?php
// Emitir boleto — PHP 8+ com ext-curl

$base  = getenv("SHARKPAY_BASE_URL");
$token = getenv("SHARKPAY_TOKEN");
$dueDate = date('Y-m-d', strtotime('+7 days')); // vencimento em 7 dias

$body = [
    'amount' => 150,
    'quantity' => 1,
    'discount' => 0,
    'tax' => 0,
    'invoice_no' => 'PED-1002',
    'due_date' => $dueDate,
    'item_name' => 'Plano anual',
    'customer' => (int) getenv("SHARKPAY_CUSTOMER_ID"),
    'instructions' => 'Não receber após o vencimento',
];

$ch = curl_init($base . '/api/boleto/create');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 30, // sempre defina um timeout
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer $token",
        "Content-Type: application/json",
        "Idempotency-Key: " . (getenv("IDEMPOTENCY_KEY") ?: bin2hex(random_bytes(16))), // reutilize a MESMA chave ao repetir
    ],
    CURLOPT_POSTFIELDS => json_encode($body),
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, " ", $response, PHP_EOL;
exit($status >= 200 && $status < 300 ? 0 : 1);

POST

/api/pix/create

Criar cobrança Pix (QR Code e copia-e-cola) · createPixCharge Bearer

Requer o método Pix habilitado. A confirmação chega por webhook (invoice.paid) ou consulta.

Parâmetros

Nome	Em	Tipo	Descrição
Idempotency-Key	header	string (mín. 8, máx. 100)	Recomendado. 8–100 caracteres `A-Za-z0-9_.:-`.

Corpo (JSON)

Campo	Tipo	Descrição
amountobrigatório	number (≤ 999999999, > 0)	Valor unitário.
quantityobrigatório	integer (≥ 1, ≤ 100000)
discountobrigatório	number (≥ 0, ≤ 100)	Desconto em %.
taxobrigatório	number (≥ 0, ≤ 100)	Imposto em %.
invoice_noobrigatório	string (máx. 100)
due_dateobrigatório	string (date)
item_nameobrigatório	string (máx. 255)
notesopcional	string (máx. 500)
emailobrigatório	string (email)
documentobrigatório	string	CPF/CNPJ do pagador.
clientobrigatório	string	Nome do pagador.

Respostas

HTTP	Descrição
200	Cobrança criada.
400	Requisição inválida ou regra de negócio violada.
401	Token ausente/inválido/expirado, ou credenciais incorretas.
409	A mesma Idempotency-Key ainda está em processamento.
422	Campos inválidos.
500	Falha inesperada. Seguro repetir com a mesma Idempotency-Key.

Campos da resposta de sucesso

Campo	Tipo	Descrição
invoice	object
invoice.reference	string
invoice.total	string
invoice.txid	string
invoice.due_date	string
invoice.copy	string	Código Pix copia-e-cola.
invoice.qrcode	string	Imagem do QR Code (conteúdo para exibição).

Exemplo · Criar cobrança Pix (QR Code e copia-e-cola)

#!/usr/bin/env bash
# Criar cobrança Pix
set -euo pipefail
: "${SHARKPAY_BASE_URL:?defina a URL base, ex.: https://pay.exemplo.com}"
: "${SHARKPAY_TOKEN:?obtenha o token com o exemplo "auth"}"
DUE=$(date -d "+7 days" +%F 2>/dev/null || date -v+7d +%F)  # vencimento daqui a 7 dias
curl -sS --fail-with-body -X POST "$SHARKPAY_BASE_URL/api/pix/create" \
  -H "Authorization: Bearer $SHARKPAY_TOKEN" \
  -H "Idempotency-Key: ${IDEMPOTENCY_KEY:-$(uuidgen)}" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 100,
  "quantity": 2,
  "discount": 10,
  "tax": 5,
  "invoice_no": "PED-1001",
  "due_date": "'"$DUE"'",
  "item_name": "Camiseta",
  "email": "maria@example.com",
  "document": "12345678909",
  "client": "Maria Souza",
  "notes": "Pedido 1001"
}'
echo

// Criar cobrança Pix — Node.js 18+ (fetch nativo, sem dependências)
import { randomUUID } from 'node:crypto';

const BASE = process.env.SHARKPAY_BASE_URL;
const TOKEN = process.env.SHARKPAY_TOKEN;
const dueDate = new Date(Date.now() + 7 * 864e5).toISOString().slice(0, 10); // vencimento em 7 dias

const body = {
  amount: 100,
  quantity: 2,
  discount: 10,
  tax: 5,
  invoice_no: "PED-1001",
  due_date: dueDate,
  item_name: "Camiseta",
  email: "maria@example.com",
  document: "12345678909",
  client: "Maria Souza",
  notes: "Pedido 1001",
};

const headers = { Authorization: `Bearer ${TOKEN}` };
headers['Content-Type'] = 'application/json';
headers['Idempotency-Key'] = process.env.IDEMPOTENCY_KEY ?? randomUUID(); // reutilize a MESMA chave ao repetir a operação
const res = await fetch(`${BASE}/api/pix/create`, {
  method: 'POST',
  headers,
  body: JSON.stringify(body),
  signal: AbortSignal.timeout(30_000), // sempre defina um timeout
});
const data = await res.json().catch(() => ({}));
console.log(res.status, JSON.stringify(data, null, 2));
if (!res.ok) process.exit(1);

# Criar cobrança Pix — Python 3.9+ (pip install requests)
import os, sys, uuid
from datetime import date, timedelta
import requests

BASE = os.environ["SHARKPAY_BASE_URL"]
TOKEN = os.environ["SHARKPAY_TOKEN"]
due_date = (date.today() + timedelta(days=7)).isoformat()  # vencimento em 7 dias

body = {
    "amount": 100,
    "quantity": 2,
    "discount": 10,
    "tax": 5,
    "invoice_no": "PED-1001",
    "due_date": due_date,
    "item_name": "Camiseta",
    "email": "maria@example.com",
    "document": "12345678909",
    "client": "Maria Souza",
    "notes": "Pedido 1001",
}

headers = {"Authorization": f"Bearer {TOKEN}"}
headers["Idempotency-Key"] = os.environ.get("IDEMPOTENCY_KEY", str(uuid.uuid4()))  # reutilize a MESMA chave ao repetir
res = requests.post(BASE + "/api/pix/create", headers=headers, json=body, timeout=30)
try:
    data = res.json()
except ValueError:
    data = {}
print(res.status_code, data)
sys.exit(0 if res.ok else 1)

<?php
// Criar cobrança Pix — PHP 8+ com ext-curl

$base  = getenv("SHARKPAY_BASE_URL");
$token = getenv("SHARKPAY_TOKEN");
$dueDate = date('Y-m-d', strtotime('+7 days')); // vencimento em 7 dias

$body = [
    'amount' => 100,
    'quantity' => 2,
    'discount' => 10,
    'tax' => 5,
    'invoice_no' => 'PED-1001',
    'due_date' => $dueDate,
    'item_name' => 'Camiseta',
    'email' => 'maria@example.com',
    'document' => '12345678909',
    'client' => 'Maria Souza',
    'notes' => 'Pedido 1001',
];

$ch = curl_init($base . '/api/pix/create');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 30, // sempre defina um timeout
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer $token",
        "Content-Type: application/json",
        "Idempotency-Key: " . (getenv("IDEMPOTENCY_KEY") ?: bin2hex(random_bytes(16))), // reutilize a MESMA chave ao repetir
    ],
    CURLOPT_POSTFIELDS => json_encode($body),
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, " ", $response, PHP_EOL;
exit($status >= 200 && $status < 300 ? 0 : 1);

GET

/api/pix/invoice/{ref}

Consultar cobrança (registro bruto) pela referência · getPixInvoice Bearer

Parâmetros

Nome	Em	Tipo	Descrição
refobrigatório	path	string

Respostas

HTTP	Descrição
200	Registro da cobrança.
401	Token ausente/inválido/expirado, ou credenciais incorretas.
404	Não encontrado (ou pertence a outra conta).

Campos da resposta de sucesso

Campo	Tipo	Descrição
invoice	object

GET

/api/pix/txid/{txid}

Consultar cobrança (registro bruto) pelo txid do Pix · getPixByTxid Bearer

Parâmetros

Nome	Em	Tipo	Descrição
txidobrigatório	path	string

Respostas

HTTP	Descrição
200	Registro da cobrança.
401	Token ausente/inválido/expirado, ou credenciais incorretas.
404	Não encontrado (ou pertence a outra conta).

Campos da resposta de sucesso

Campo	Tipo	Descrição
invoice	object

POST

/api/pixout/create

Solicitar saque Pix · createPixout Bearer

Reserva o saldo (valor + tarifa) de forma atômica e envia ao banco. Idempotency-Key é obrigatório.
Se o banco recusar, o valor é estornado e o saque fica CANCELED.

Parâmetros

Nome	Em	Tipo	Descrição
Idempotency-Keyobrigatório	header	string (mín. 8, máx. 100)

Corpo (JSON)

Campo	Tipo	Descrição
amountobrigatório	number (> 0)
pixkeyobrigatório	string (máx. 140)
keytypeobrigatório	string (CPF, CNPJ, EMAIL, PHONE, EVP)
clientopcional	string
documentopcional	string
emailopcional	string (email)
descriptionopcional	string (máx. 140)

Respostas

HTTP	Descrição
200	Saque registrado.
400	Requisição inválida ou regra de negócio violada.
401	Token ausente/inválido/expirado, ou credenciais incorretas.
409	A mesma Idempotency-Key ainda está em processamento.
422	Campos inválidos.
500	Falha inesperada. Seguro repetir com a mesma Idempotency-Key.

Campos da resposta de sucesso

Campo	Tipo	Descrição
success	boolean
message	string
withdraw	object
withdraw.reference	string
withdraw.total	string	valor + tarifa
withdraw.charge	string
withdraw.loquidAmount deprecated	string	Nome legado (grafia original). Use netAmount.
withdraw.netAmount	string
withdraw.status	string (PENDING, PAID, CANCELED)
withdraw.pixkey	string
withdraw.keytype	string
withdraw.destinataryName	string \| null
withdraw.destinataryDocument	string \| null
withdraw.destinataryEmail	string \| null
withdraw.paidAt	string \| null
withdraw.entoend deprecated	string \| null	Nome legado. Use endToEndId.
withdraw.endToEndId	string \| null
withdraw.errorMsg	string \| null
withdraw.created_at	string
withdraw.updated_at	string

Exemplo · Solicitar saque Pix

#!/usr/bin/env bash
# Solicitar saque Pix
set -euo pipefail
: "${SHARKPAY_BASE_URL:?defina a URL base, ex.: https://pay.exemplo.com}"
: "${SHARKPAY_TOKEN:?obtenha o token com o exemplo "auth"}"
curl -sS --fail-with-body -X POST "$SHARKPAY_BASE_URL/api/pixout/create" \
  -H "Authorization: Bearer $SHARKPAY_TOKEN" \
  -H "Idempotency-Key: ${IDEMPOTENCY_KEY:-$(uuidgen)}" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 50,
  "pixkey": "maria@example.com",
  "keytype": "EMAIL",
  "client": "Maria Souza",
  "document": "12345678909",
  "description": "Repasse"
}'
echo

// Solicitar saque Pix — Node.js 18+ (fetch nativo, sem dependências)
import { randomUUID } from 'node:crypto';

const BASE = process.env.SHARKPAY_BASE_URL;
const TOKEN = process.env.SHARKPAY_TOKEN;

const body = {
  amount: 50,
  pixkey: "maria@example.com",
  keytype: "EMAIL",
  client: "Maria Souza",
  document: "12345678909",
  description: "Repasse",
};

const headers = { Authorization: `Bearer ${TOKEN}` };
headers['Content-Type'] = 'application/json';
headers['Idempotency-Key'] = process.env.IDEMPOTENCY_KEY ?? randomUUID(); // reutilize a MESMA chave ao repetir a operação
const res = await fetch(`${BASE}/api/pixout/create`, {
  method: 'POST',
  headers,
  body: JSON.stringify(body),
  signal: AbortSignal.timeout(30_000), // sempre defina um timeout
});
const data = await res.json().catch(() => ({}));
console.log(res.status, JSON.stringify(data, null, 2));
if (!res.ok) process.exit(1);

# Solicitar saque Pix — Python 3.9+ (pip install requests)
import os, sys, uuid
import requests

BASE = os.environ["SHARKPAY_BASE_URL"]
TOKEN = os.environ["SHARKPAY_TOKEN"]

body = {
    "amount": 50,
    "pixkey": "maria@example.com",
    "keytype": "EMAIL",
    "client": "Maria Souza",
    "document": "12345678909",
    "description": "Repasse",
}

headers = {"Authorization": f"Bearer {TOKEN}"}
headers["Idempotency-Key"] = os.environ.get("IDEMPOTENCY_KEY", str(uuid.uuid4()))  # reutilize a MESMA chave ao repetir
res = requests.post(BASE + "/api/pixout/create", headers=headers, json=body, timeout=30)
try:
    data = res.json()
except ValueError:
    data = {}
print(res.status_code, data)
sys.exit(0 if res.ok else 1)

<?php
// Solicitar saque Pix — PHP 8+ com ext-curl

$base  = getenv("SHARKPAY_BASE_URL");
$token = getenv("SHARKPAY_TOKEN");

$body = [
    'amount' => 50,
    'pixkey' => 'maria@example.com',
    'keytype' => 'EMAIL',
    'client' => 'Maria Souza',
    'document' => '12345678909',
    'description' => 'Repasse',
];

$ch = curl_init($base . '/api/pixout/create');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 30, // sempre defina um timeout
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer $token",
        "Content-Type: application/json",
        "Idempotency-Key: " . (getenv("IDEMPOTENCY_KEY") ?: bin2hex(random_bytes(16))), // reutilize a MESMA chave ao repetir
    ],
    CURLOPT_POSTFIELDS => json_encode($body),
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, " ", $response, PHP_EOL;
exit($status >= 200 && $status < 300 ? 0 : 1);

GET

/api/pixout/withdraw/{txid}

Consultar saque pela referência · getPixout Bearer

Parâmetros

Nome	Em	Tipo	Descrição
txidobrigatório	path	string	Valor de `reference` do saque.

Respostas

HTTP	Descrição
200	Saque.
401	Token ausente/inválido/expirado, ou credenciais incorretas.
404	Não encontrado (ou pertence a outra conta).

Campos da resposta de sucesso

Campo	Tipo	Descrição
success	boolean
withdraw	object
withdraw.reference	string
withdraw.total	string	valor + tarifa
withdraw.charge	string
withdraw.loquidAmount deprecated	string	Nome legado (grafia original). Use netAmount.
withdraw.netAmount	string
withdraw.status	string (PENDING, PAID, CANCELED)
withdraw.pixkey	string
withdraw.keytype	string
withdraw.destinataryName	string \| null
withdraw.destinataryDocument	string \| null
withdraw.destinataryEmail	string \| null
withdraw.paidAt	string \| null
withdraw.entoend deprecated	string \| null	Nome legado. Use endToEndId.
withdraw.endToEndId	string \| null
withdraw.errorMsg	string \| null
withdraw.created_at	string
withdraw.updated_at	string

Exemplo · Consultar saque pela referência

#!/usr/bin/env bash
# Consultar saque
set -euo pipefail
: "${SHARKPAY_BASE_URL:?defina a URL base, ex.: https://pay.exemplo.com}"
: "${SHARKPAY_TOKEN:?obtenha o token com o exemplo "auth"}"
curl -sS --fail-with-body -X GET "$SHARKPAY_BASE_URL/api/pixout/withdraw/$SHARKPAY_WITHDRAW_REF" \
  -H "Authorization: Bearer $SHARKPAY_TOKEN"
echo

// Consultar saque — Node.js 18+ (fetch nativo, sem dependências)
import { randomUUID } from 'node:crypto';

const BASE = process.env.SHARKPAY_BASE_URL;
const TOKEN = process.env.SHARKPAY_TOKEN;

const headers = { Authorization: `Bearer ${TOKEN}` };
const res = await fetch(`${BASE}/api/pixout/withdraw/${process.env.SHARKPAY_WITHDRAW_REF}`, {
  method: 'GET',
  headers,
  signal: AbortSignal.timeout(30_000), // sempre defina um timeout
});
const data = await res.json().catch(() => ({}));
console.log(res.status, JSON.stringify(data, null, 2));
if (!res.ok) process.exit(1);

# Consultar saque — Python 3.9+ (pip install requests)
import os, sys, uuid
import requests

BASE = os.environ["SHARKPAY_BASE_URL"]
TOKEN = os.environ["SHARKPAY_TOKEN"]

headers = {"Authorization": f"Bearer {TOKEN}"}
res = requests.get(BASE + "/api/pixout/withdraw/" + os.environ["SHARKPAY_WITHDRAW_REF"] + "", headers=headers, timeout=30)
try:
    data = res.json()
except ValueError:
    data = {}
print(res.status_code, data)
sys.exit(0 if res.ok else 1)

<?php
// Consultar saque — PHP 8+ com ext-curl

$base  = getenv("SHARKPAY_BASE_URL");
$token = getenv("SHARKPAY_TOKEN");

$ch = curl_init($base . '/api/pixout/withdraw/' . getenv('SHARKPAY_WITHDRAW_REF'));
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 30, // sempre defina um timeout
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer $token",
    ],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, " ", $response, PHP_EOL;
exit($status >= 200 && $status < 300 ? 0 : 1);

GET

/api/pixout/list

Listar saques (25 por página) · listPixouts Bearer

Parâmetros

Nome	Em	Tipo	Descrição
page	query	integer (≥ 1)
start	query	string (date)	YYYY-MM-DD
end	query	string (date)	YYYY-MM-DD
status	query	string (PENDING, PAID, CANCELED)

Respostas

HTTP	Descrição
200	Saques.
400	Requisição inválida ou regra de negócio violada.
401	Token ausente/inválido/expirado, ou credenciais incorretas.

Campos da resposta de sucesso

Campo	Tipo	Descrição
success	boolean
withdrawals	array<object>
withdrawals[].reference	string
withdrawals[].total	string	valor + tarifa
withdrawals[].charge	string
withdrawals[].loquidAmount deprecated	string	Nome legado (grafia original). Use netAmount.
withdrawals[].netAmount	string
withdrawals[].status	string (PENDING, PAID, CANCELED)
withdrawals[].pixkey	string
withdrawals[].keytype	string
withdrawals[].destinataryName	string \| null
withdrawals[].destinataryDocument	string \| null
withdrawals[].destinataryEmail	string \| null
withdrawals[].paidAt	string \| null
withdrawals[].entoend deprecated	string \| null	Nome legado. Use endToEndId.
withdrawals[].endToEndId	string \| null
withdrawals[].errorMsg	string \| null
withdrawals[].created_at	string
withdrawals[].updated_at	string

POST

/api/customer

Cadastrar cliente · createCustomer Bearer

Parâmetros

Nome	Em	Tipo	Descrição
Idempotency-Key	header	string (mín. 8, máx. 100)	Recomendado. 8–100 caracteres `A-Za-z0-9_.:-`.

Corpo (JSON)

Campo	Tipo	Descrição
nameobrigatório	string
documentobrigatório	string
document_typeobrigatório	string (CPF, CNPJ)
zipcodeobrigatório	string
country_idobrigatório	integer	Id de GET /api/country/all.
stateobrigatório	string (mín. 2, máx. 2)	UF.
cityobrigatório	string
districtobrigatório	string
streetobrigatório	string
numberobrigatório	string
emailobrigatório	string (email)
phoneobrigatório	string
mobilephoneobrigatório	string

Respostas

HTTP	Descrição
200	Cliente criado.
400	Requisição inválida ou regra de negócio violada.
401	Token ausente/inválido/expirado, ou credenciais incorretas.
409	Requisição inválida ou regra de negócio violada.
422	Campos inválidos.

Campos da resposta de sucesso

Campo	Tipo	Descrição
customer	object
customer.id	integer
customer.name	string
customer.document	string
customer.document_type	string
customer.zipcode	string
customer.country	object
customer.country.id	integer
customer.country.iso	string
customer.country.name	string
customer.country.nicename	string
customer.country.iso3	string \| null
customer.country.numcode	integer \| null
customer.country.phonecode	integer \| null
customer.state	object
customer.state.name	string
customer.state.uf	string
customer.state.ibge	string \| integer \| null
customer.state.ddd	string \| integer \| null
customer.city	string
customer.district	string
customer.street	string
customer.number	string
customer.email	string
customer.phone	string
customer.mobilephone	string

Exemplo · Cadastrar cliente

#!/usr/bin/env bash
# Cadastrar cliente
set -euo pipefail
: "${SHARKPAY_BASE_URL:?defina a URL base, ex.: https://pay.exemplo.com}"
: "${SHARKPAY_TOKEN:?obtenha o token com o exemplo "auth"}"
curl -sS --fail-with-body -X POST "$SHARKPAY_BASE_URL/api/customer" \
  -H "Authorization: Bearer $SHARKPAY_TOKEN" \
  -H "Idempotency-Key: ${IDEMPOTENCY_KEY:-$(uuidgen)}" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Maria Souza",
  "document": "12345678909",
  "document_type": "CPF",
  "zipcode": "01001000",
  "country_id": 30,
  "state": "SP",
  "city": "São Paulo",
  "district": "Sé",
  "street": "Praça da Sé",
  "number": "100",
  "email": "maria@example.com",
  "phone": "1133334444",
  "mobilephone": "11999998888"
}'
echo

// Cadastrar cliente — Node.js 18+ (fetch nativo, sem dependências)
import { randomUUID } from 'node:crypto';

const BASE = process.env.SHARKPAY_BASE_URL;
const TOKEN = process.env.SHARKPAY_TOKEN;

const body = {
  name: "Maria Souza",
  document: "12345678909",
  document_type: "CPF",
  zipcode: "01001000",
  country_id: 30,
  state: "SP",
  city: "São Paulo",
  district: "Sé",
  street: "Praça da Sé",
  number: "100",
  email: "maria@example.com",
  phone: "1133334444",
  mobilephone: "11999998888",
};

const headers = { Authorization: `Bearer ${TOKEN}` };
headers['Content-Type'] = 'application/json';
headers['Idempotency-Key'] = process.env.IDEMPOTENCY_KEY ?? randomUUID(); // reutilize a MESMA chave ao repetir a operação
const res = await fetch(`${BASE}/api/customer`, {
  method: 'POST',
  headers,
  body: JSON.stringify(body),
  signal: AbortSignal.timeout(30_000), // sempre defina um timeout
});
const data = await res.json().catch(() => ({}));
console.log(res.status, JSON.stringify(data, null, 2));
if (!res.ok) process.exit(1);

# Cadastrar cliente — Python 3.9+ (pip install requests)
import os, sys, uuid
import requests

BASE = os.environ["SHARKPAY_BASE_URL"]
TOKEN = os.environ["SHARKPAY_TOKEN"]

body = {
    "name": "Maria Souza",
    "document": "12345678909",
    "document_type": "CPF",
    "zipcode": "01001000",
    "country_id": 30,
    "state": "SP",
    "city": "São Paulo",
    "district": "Sé",
    "street": "Praça da Sé",
    "number": "100",
    "email": "maria@example.com",
    "phone": "1133334444",
    "mobilephone": "11999998888",
}

headers = {"Authorization": f"Bearer {TOKEN}"}
headers["Idempotency-Key"] = os.environ.get("IDEMPOTENCY_KEY", str(uuid.uuid4()))  # reutilize a MESMA chave ao repetir
res = requests.post(BASE + "/api/customer", headers=headers, json=body, timeout=30)
try:
    data = res.json()
except ValueError:
    data = {}
print(res.status_code, data)
sys.exit(0 if res.ok else 1)

<?php
// Cadastrar cliente — PHP 8+ com ext-curl

$base  = getenv("SHARKPAY_BASE_URL");
$token = getenv("SHARKPAY_TOKEN");

$body = [
    'name' => 'Maria Souza',
    'document' => '12345678909',
    'document_type' => 'CPF',
    'zipcode' => '01001000',
    'country_id' => 30,
    'state' => 'SP',
    'city' => 'São Paulo',
    'district' => 'Sé',
    'street' => 'Praça da Sé',
    'number' => '100',
    'email' => 'maria@example.com',
    'phone' => '1133334444',
    'mobilephone' => '11999998888',
];

$ch = curl_init($base . '/api/customer');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 30, // sempre defina um timeout
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer $token",
        "Content-Type: application/json",
        "Idempotency-Key: " . (getenv("IDEMPOTENCY_KEY") ?: bin2hex(random_bytes(16))), // reutilize a MESMA chave ao repetir
    ],
    CURLOPT_POSTFIELDS => json_encode($body),
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, " ", $response, PHP_EOL;
exit($status >= 200 && $status < 300 ? 0 : 1);

GET

/api/customer/{custome_id}

Consultar cliente · getCustomer Bearer

Parâmetros

Nome	Em	Tipo	Descrição
custome_idobrigatório	path	integer	Id numérico do cliente (o nome do parâmetro mantém a grafia original da rota).

Respostas

HTTP	Descrição
200	Cliente.
400	Requisição inválida ou regra de negócio violada.
401	Token ausente/inválido/expirado, ou credenciais incorretas.
404	Não encontrado (ou pertence a outra conta).

Campos da resposta de sucesso

Campo	Tipo	Descrição
customer	object
customer.id	integer
customer.name	string
customer.document	string
customer.document_type	string
customer.zipcode	string
customer.country	object
customer.country.id	integer
customer.country.iso	string
customer.country.name	string
customer.country.nicename	string
customer.country.iso3	string \| null
customer.country.numcode	integer \| null
customer.country.phonecode	integer \| null
customer.state	object
customer.state.name	string
customer.state.uf	string
customer.state.ibge	string \| integer \| null
customer.state.ddd	string \| integer \| null
customer.city	string
customer.district	string
customer.street	string
customer.number	string
customer.email	string
customer.phone	string
customer.mobilephone	string

GET

/api/customers

Listar/buscar clientes · listCustomers Bearer

Parâmetros

Nome	Em	Tipo
page	query	integer (≥ 1)
limit	query	integer (≥ 1, ≤ 50)
document	query	string
name	query	string
email	query	string
phone	query	string
mobilephone	query	string

Respostas

HTTP	Descrição
200	Clientes.
401	Token ausente/inválido/expirado, ou credenciais incorretas.

Campos da resposta de sucesso

Campo	Tipo	Descrição
customers	array<object>
customers[].id	integer
customers[].name	string
customers[].document	string
customers[].document_type	string
customers[].zipcode	string
customers[].country	object
customers[].country.id	integer
customers[].country.iso	string
customers[].country.name	string
customers[].country.nicename	string
customers[].country.iso3	string \| null
customers[].country.numcode	integer \| null
customers[].country.phonecode	integer \| null
customers[].state	object
customers[].state.name	string
customers[].state.uf	string
customers[].state.ibge	string \| integer \| null
customers[].state.ddd	string \| integer \| null
customers[].city	string
customers[].district	string
customers[].street	string
customers[].number	string
customers[].email	string
customers[].phone	string
customers[].mobilephone	string
pagination	object
pagination.page	integer
pagination.limit	integer

GET

/api/checkout/{tx_ref}

Consultar o resultado de um checkout hospedado · getCheckout Bearer

Use o tx_ref que você enviou no formulário POST /ext_transfer. Sempre confirme o pagamento por esta
consulta no seu servidor antes de liberar o pedido — o redirecionamento do cliente a callback_url não prova pagamento.

Parâmetros

Nome	Em	Tipo	Descrição
tx_refobrigatório	path	string

Respostas

HTTP	Descrição
200	Transação.
401	Token ausente/inválido/expirado, ou credenciais incorretas.
404	Não encontrado (ou pertence a outra conta).

Campos da resposta de sucesso

Campo	Tipo	Descrição
checkout	object
checkout.tx_ref	string
checkout.reference	string
checkout.status	string (PENDING, PAID, ABANDONED, UNKNOWN)
checkout.title	string
checkout.quantity	integer
checkout.amount	string
checkout.total	string
checkout.email	string
checkout.first_name	string
checkout.last_name	string
checkout.payment_type	string \| null
checkout.created_at	string

Exemplo · Consultar o resultado de um checkout hospedado

#!/usr/bin/env bash
# Confirmar pagamento do checkout hospedado
set -euo pipefail
: "${SHARKPAY_BASE_URL:?defina a URL base, ex.: https://pay.exemplo.com}"
: "${SHARKPAY_TOKEN:?obtenha o token com o exemplo "auth"}"
curl -sS --fail-with-body -X GET "$SHARKPAY_BASE_URL/api/checkout/$SHARKPAY_TX_REF" \
  -H "Authorization: Bearer $SHARKPAY_TOKEN"
echo

// Confirmar pagamento do checkout hospedado — Node.js 18+ (fetch nativo, sem dependências)
import { randomUUID } from 'node:crypto';

const BASE = process.env.SHARKPAY_BASE_URL;
const TOKEN = process.env.SHARKPAY_TOKEN;

const headers = { Authorization: `Bearer ${TOKEN}` };
const res = await fetch(`${BASE}/api/checkout/${process.env.SHARKPAY_TX_REF}`, {
  method: 'GET',
  headers,
  signal: AbortSignal.timeout(30_000), // sempre defina um timeout
});
const data = await res.json().catch(() => ({}));
console.log(res.status, JSON.stringify(data, null, 2));
if (!res.ok) process.exit(1);

# Confirmar pagamento do checkout hospedado — Python 3.9+ (pip install requests)
import os, sys, uuid
import requests

BASE = os.environ["SHARKPAY_BASE_URL"]
TOKEN = os.environ["SHARKPAY_TOKEN"]

headers = {"Authorization": f"Bearer {TOKEN}"}
res = requests.get(BASE + "/api/checkout/" + os.environ["SHARKPAY_TX_REF"] + "", headers=headers, timeout=30)
try:
    data = res.json()
except ValueError:
    data = {}
print(res.status_code, data)
sys.exit(0 if res.ok else 1)

<?php
// Confirmar pagamento do checkout hospedado — PHP 8+ com ext-curl

$base  = getenv("SHARKPAY_BASE_URL");
$token = getenv("SHARKPAY_TOKEN");

$ch = curl_init($base . '/api/checkout/' . getenv('SHARKPAY_TX_REF'));
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 30, // sempre defina um timeout
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer $token",
    ],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, " ", $response, PHP_EOL;
exit($status >= 200 && $status < 300 ? 0 : 1);

GET

/api/webhook

Ver configuração do webhook · getWebhook Bearer

Respostas

HTTP	Descrição
200	Configuração (o segredo nunca é devolvido aqui).
401	Token ausente/inválido/expirado, ou credenciais incorretas.

Campos da resposta de sucesso

Campo	Tipo	Descrição
webhook	object
webhook.url	string \| null
webhook.secret_configured	boolean
webhook.events	array<string>

PUT

/api/webhook

Definir a URL do webhook · setWebhook Bearer

A URL deve ser https, sem credenciais, porta 443/8443 e não pode resolver para IP privado/reservado.
Na primeira configuração é gerado o segredo de assinatura (whsec_...), mostrado uma única vez.

Corpo (JSON)

Campo	Tipo	Descrição
urlobrigatório	string (máx. 255, uri)

Respostas

HTTP	Descrição
200	URL salva.
401	Token ausente/inválido/expirado, ou credenciais incorretas.
422	Requisição inválida ou regra de negócio violada.

Campos da resposta de sucesso

Campo	Tipo	Descrição
webhook	object
webhook.url	string
webhook.secret	string	Somente na primeira configuração.
webhook.secret_notice	string

Exemplo · Definir a URL do webhook

#!/usr/bin/env bash
# Configurar a URL do webhook
set -euo pipefail
: "${SHARKPAY_BASE_URL:?defina a URL base, ex.: https://pay.exemplo.com}"
: "${SHARKPAY_TOKEN:?obtenha o token com o exemplo "auth"}"
curl -sS --fail-with-body -X PUT "$SHARKPAY_BASE_URL/api/webhook" \
  -H "Authorization: Bearer $SHARKPAY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "'"$WEBHOOK_URL"'"
}'
echo

// Configurar a URL do webhook — Node.js 18+ (fetch nativo, sem dependências)
import { randomUUID } from 'node:crypto';

const BASE = process.env.SHARKPAY_BASE_URL;
const TOKEN = process.env.SHARKPAY_TOKEN;

const body = {
  url: process.env.WEBHOOK_URL,
};

const headers = { Authorization: `Bearer ${TOKEN}` };
headers['Content-Type'] = 'application/json';
const res = await fetch(`${BASE}/api/webhook`, {
  method: 'PUT',
  headers,
  body: JSON.stringify(body),
  signal: AbortSignal.timeout(30_000), // sempre defina um timeout
});
const data = await res.json().catch(() => ({}));
console.log(res.status, JSON.stringify(data, null, 2));
if (!res.ok) process.exit(1);

# Configurar a URL do webhook — Python 3.9+ (pip install requests)
import os, sys, uuid
import requests

BASE = os.environ["SHARKPAY_BASE_URL"]
TOKEN = os.environ["SHARKPAY_TOKEN"]

body = {
    "url": os.environ["WEBHOOK_URL"],
}

headers = {"Authorization": f"Bearer {TOKEN}"}
res = requests.put(BASE + "/api/webhook", headers=headers, json=body, timeout=30)
try:
    data = res.json()
except ValueError:
    data = {}
print(res.status_code, data)
sys.exit(0 if res.ok else 1)

<?php
// Configurar a URL do webhook — PHP 8+ com ext-curl

$base  = getenv("SHARKPAY_BASE_URL");
$token = getenv("SHARKPAY_TOKEN");

$body = [
    'url' => getenv("WEBHOOK_URL"),
];

$ch = curl_init($base . '/api/webhook');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 30, // sempre defina um timeout
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer $token",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode($body),
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, " ", $response, PHP_EOL;
exit($status >= 200 && $status < 300 ? 0 : 1);

POST

/api/webhook/secret/rotate

Gerar novo segredo de assinatura · rotateWebhookSecret Bearer

O segredo anterior deixa de valer imediatamente. O novo é mostrado uma única vez.

Respostas

HTTP	Descrição
200	Novo segredo.
401	Token ausente/inválido/expirado, ou credenciais incorretas.

Campos da resposta de sucesso

Campo	Tipo	Descrição
webhook	object
webhook.secret	string
webhook.secret_notice	string

POST

/api/webhook/test

Enfileirar um evento `ping` · testWebhook Bearer

Respostas

HTTP	Descrição
202	Evento na fila.
401	Token ausente/inválido/expirado, ou credenciais incorretas.
409	Requisição inválida ou regra de negócio violada.

Campos da resposta de sucesso

Campo	Tipo	Descrição
event_id	string
status	string

Exemplo · Enfileirar um evento `ping`

#!/usr/bin/env bash
# Enviar evento de teste
set -euo pipefail
: "${SHARKPAY_BASE_URL:?defina a URL base, ex.: https://pay.exemplo.com}"
: "${SHARKPAY_TOKEN:?obtenha o token com o exemplo "auth"}"
curl -sS --fail-with-body -X POST "$SHARKPAY_BASE_URL/api/webhook/test" \
  -H "Authorization: Bearer $SHARKPAY_TOKEN"
echo

// Enviar evento de teste — Node.js 18+ (fetch nativo, sem dependências)
import { randomUUID } from 'node:crypto';

const BASE = process.env.SHARKPAY_BASE_URL;
const TOKEN = process.env.SHARKPAY_TOKEN;

const headers = { Authorization: `Bearer ${TOKEN}` };
const res = await fetch(`${BASE}/api/webhook/test`, {
  method: 'POST',
  headers,
  signal: AbortSignal.timeout(30_000), // sempre defina um timeout
});
const data = await res.json().catch(() => ({}));
console.log(res.status, JSON.stringify(data, null, 2));
if (!res.ok) process.exit(1);

# Enviar evento de teste — Python 3.9+ (pip install requests)
import os, sys, uuid
import requests

BASE = os.environ["SHARKPAY_BASE_URL"]
TOKEN = os.environ["SHARKPAY_TOKEN"]

headers = {"Authorization": f"Bearer {TOKEN}"}
res = requests.post(BASE + "/api/webhook/test", headers=headers, timeout=30)
try:
    data = res.json()
except ValueError:
    data = {}
print(res.status_code, data)
sys.exit(0 if res.ok else 1)

<?php
// Enviar evento de teste — PHP 8+ com ext-curl

$base  = getenv("SHARKPAY_BASE_URL");
$token = getenv("SHARKPAY_TOKEN");

$ch = curl_init($base . '/api/webhook/test');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 30, // sempre defina um timeout
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer $token",
    ],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, " ", $response, PHP_EOL;
exit($status >= 200 && $status < 300 ? 0 : 1);

GET

/api/webhook/deliveries

Últimas 25 entregas (diagnóstico) · listWebhookDeliveries Bearer

Respostas

HTTP	Descrição
200	Entregas.
401	Token ausente/inválido/expirado, ou credenciais incorretas.

Campos da resposta de sucesso

Campo	Tipo	Descrição
deliveries	array<object>
deliveries[].event_id	string
deliveries[].type	string
deliveries[].attempts	integer
deliveries[].last_status	integer \| null
deliveries[].last_error	string \| null
deliveries[].delivered_at	string \| null
deliveries[].failed_at	string \| null
deliveries[].next_attempt_at	string \| null
deliveries[].created_at	string

Exemplo · Últimas 25 entregas (diagnóstico)

#!/usr/bin/env bash
# Ver entregas recentes
set -euo pipefail
: "${SHARKPAY_BASE_URL:?defina a URL base, ex.: https://pay.exemplo.com}"
: "${SHARKPAY_TOKEN:?obtenha o token com o exemplo "auth"}"
curl -sS --fail-with-body -X GET "$SHARKPAY_BASE_URL/api/webhook/deliveries" \
  -H "Authorization: Bearer $SHARKPAY_TOKEN"
echo

// Ver entregas recentes — Node.js 18+ (fetch nativo, sem dependências)
import { randomUUID } from 'node:crypto';

const BASE = process.env.SHARKPAY_BASE_URL;
const TOKEN = process.env.SHARKPAY_TOKEN;

const headers = { Authorization: `Bearer ${TOKEN}` };
const res = await fetch(`${BASE}/api/webhook/deliveries`, {
  method: 'GET',
  headers,
  signal: AbortSignal.timeout(30_000), // sempre defina um timeout
});
const data = await res.json().catch(() => ({}));
console.log(res.status, JSON.stringify(data, null, 2));
if (!res.ok) process.exit(1);

# Ver entregas recentes — Python 3.9+ (pip install requests)
import os, sys, uuid
import requests

BASE = os.environ["SHARKPAY_BASE_URL"]
TOKEN = os.environ["SHARKPAY_TOKEN"]

headers = {"Authorization": f"Bearer {TOKEN}"}
res = requests.get(BASE + "/api/webhook/deliveries", headers=headers, timeout=30)
try:
    data = res.json()
except ValueError:
    data = {}
print(res.status_code, data)
sys.exit(0 if res.ok else 1)

<?php
// Ver entregas recentes — PHP 8+ com ext-curl

$base  = getenv("SHARKPAY_BASE_URL");
$token = getenv("SHARKPAY_TOKEN");

$ch = curl_init($base . '/api/webhook/deliveries');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 30, // sempre defina um timeout
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer $token",
    ],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, " ", $response, PHP_EOL;
exit($status >= 200 && $status < 300 ? 0 : 1);

GET

/api/country/all

Listar países · listCountries Bearer

Respostas

HTTP	Descrição
200	Países.
401	Token ausente/inválido/expirado, ou credenciais incorretas.

Campos da resposta de sucesso

Campo	Tipo	Descrição
countries	array<object>
countries[].id	integer
countries[].iso	string
countries[].name	string
countries[].nicename	string
countries[].iso3	string \| null
countries[].numcode	integer \| null
countries[].phonecode	integer \| null

GET

/api/country/{country_id}

Consultar país pelo id · getCountry Bearer

Parâmetros

Nome	Em	Tipo	Descrição
country_idobrigatório	path	integer

Respostas

HTTP	Descrição
200	País.
400	Requisição inválida ou regra de negócio violada.
404	Não encontrado (ou pertence a outra conta).

Campos da resposta de sucesso

Campo	Tipo	Descrição
country	object
country.id	integer
country.iso	string
country.name	string
country.nicename	string
country.iso3	string \| null
country.numcode	integer \| null
country.phonecode	integer \| null

GET

/api/country/iso/{iso}

Consultar país pelo código ISO (2 letras) · getCountryByIso Bearer

Parâmetros

Nome	Em	Tipo	Descrição
isoobrigatório	path	string (mín. 2, máx. 2)

Respostas

HTTP	Descrição
200	País.
404	Não encontrado (ou pertence a outra conta).

Campos da resposta de sucesso

Campo	Tipo	Descrição
country	object
country.id	integer
country.iso	string
country.name	string
country.nicename	string
country.iso3	string \| null
country.numcode	integer \| null
country.phonecode	integer \| null

GET

/api/country/iso3/{iso3}

Consultar país pelo código ISO3 · getCountryByIso3 Bearer

Parâmetros

Nome	Em	Tipo	Descrição
iso3obrigatório	path	string (mín. 3, máx. 3)

Respostas

HTTP	Descrição
200	País.
404	Não encontrado (ou pertence a outra conta).

Campos da resposta de sucesso

Campo	Tipo	Descrição
country	object
country.id	integer
country.iso	string
country.name	string
country.nicename	string
country.iso3	string \| null
country.numcode	integer \| null
country.phonecode	integer \| null

GET

/api/state/all

Listar estados · listStates Bearer

Respostas

HTTP	Descrição
200	Estados.
401	Token ausente/inválido/expirado, ou credenciais incorretas.

Campos da resposta de sucesso

Campo	Tipo	Descrição
states	array<object>
states[].id	integer
states[].name	string
states[].uf	string
states[].ibge	string \| integer \| null
states[].ddd	string \| integer \| null

GET

/api/state/{state_id}

Consultar estado pelo id · getState Bearer

Parâmetros

Nome	Em	Tipo	Descrição
state_idobrigatório	path	integer

Respostas

HTTP	Descrição
200	Estado.
404	Não encontrado (ou pertence a outra conta).

Campos da resposta de sucesso

Campo	Tipo	Descrição
state	object
state.id	integer
state.name	string
state.uf	string
state.ibge	string \| integer \| null
state.ddd	string \| integer \| null

GET

/api/state/uf/{uf}

Consultar estado pela UF (2 letras) · getStateByUf Bearer

Parâmetros

Nome	Em	Tipo	Descrição
ufobrigatório	path	string (mín. 2, máx. 2)

Respostas

HTTP	Descrição
200	Estado.
404	Não encontrado (ou pertence a outra conta).

Campos da resposta de sucesso

Campo	Tipo	Descrição
state	object
state.id	integer
state.name	string
state.uf	string
state.ibge	string \| integer \| null
state.ddd	string \| integer \| null

GET

/api/cep/search/{cep}

Buscar endereço por CEP (sem autenticação) · searchCep sem autenticação

Parâmetros

Nome	Em	Tipo	Descrição
cepobrigatório	path	string	8 dígitos (hífen opcional).

Respostas

HTTP	Descrição
200	Endereço.
422	Requisição inválida ou regra de negócio violada.
429	Limite de requisições excedido. Aguarde `Retry-After` segundos.

Campos da resposta de sucesso

Campo	Tipo	Descrição
success	boolean
address	object
address.cep	string
address.logradouro	string
address.complemento	string
address.bairro	string
address.localidade	string
address.uf	string
address.ibge	string

POST

/api/originalbank/account/register

Abrir conta no Banco Original (uso interno/parceiro) · registerOriginalBankAccount Bearer

Fluxo de integração com o banco parceiro, fora do contrato público estável. Pode mudar sem aviso.

Respostas

HTTP	Descrição
200	Resultado do banco.
401	Token ausente/inválido/expirado, ou credenciais incorretas.
500	Falha inesperada. Seguro repetir com a mesma Idempotency-Key.

Campos da resposta de sucesso

Campo	Tipo	Descrição
success	boolean
result	object

Documentação da API

Convenções

Autenticação

/api/auth

Respostas

Cobranças

/api/invoices

Parâmetros

Respostas

/api/invoice/{invoice_id}

Parâmetros

Respostas

/api/invoice/ref/{ref_id}

Parâmetros

Respostas

/api/creditcard/create

Parâmetros

Corpo (JSON)

Respostas

/api/boleto/create

Parâmetros

Corpo (JSON)

Respostas

Pix

/api/pix/create

Parâmetros

Corpo (JSON)

Respostas

/api/pix/invoice/{ref}

Parâmetros

Respostas

/api/pix/txid/{txid}

Parâmetros

Respostas

Saques Pix

/api/pixout/create

Parâmetros

Corpo (JSON)

Respostas

/api/pixout/withdraw/{txid}

Parâmetros

Respostas

/api/pixout/list

Parâmetros

Respostas

Clientes

/api/customer

Parâmetros

Corpo (JSON)

Respostas

/api/customer/{custome_id}

Parâmetros

Respostas

/api/customers

Parâmetros

Respostas

Checkout hospedado

/api/checkout/{tx_ref}

Parâmetros

Respostas

Webhooks

/api/webhook

Respostas

/api/webhook

Corpo (JSON)

Respostas

/api/webhook/secret/rotate

Respostas

/api/webhook/test

Respostas

/api/webhook/deliveries

Respostas

Referência

/api/country/all

Respostas

/api/country/{country_id}

Parâmetros

Respostas

/api/country/iso/{iso}