Criar Cobrança

paymentMethod = CREDIT_CARD não é aceito neste endpoint — dados sensíveis de cartão devem passar apenas pelo checkout público (POST /charge/{id}/checkout/payment com X-Checkout-Token).

Novo Split de Pagamento — distribua o valor da cobrança entre múltiplos destinatários usando o campo split[]. Suporta valor fixo (FIXED em reais) e percentual (PERCENT sobre o netAmount). Veja os detalhes na seção de parâmetros abaixo.

Parâmetros

Authorization

string

obrigatório

Token de autenticação no formato Bearer.

grossAmount

string

obrigatório

Valor bruto da cobrança em reais (duas casas decimais).

currency

string

obrigatório

Moeda da cobrança (ISO 4217). Hoje sempre BRL — para pagamento em outra moeda, use checkoutCurrency com paymentMethod = INTERNATIONAL.

paymentMethod

string

Se informado, cria a primeira tentativa junto com a cobrança. Valores aceitos:

PIX — cria tentativa com instruções PIX (QR code, EMV).
INTERNATIONAL — cria checkout session via Revolut. Requer checkoutCurrency.

Se omitido, a cobrança é criada em PENDING sem tentativa.

checkoutCurrency

string

Moeda em que o pagador vai pagar no gateway (ISO 4217, ex.: USD, EUR, MXN). Obrigatório quando paymentMethod = INTERNATIONAL.

description

string

Descrição livre da cobrança.

expiresAt

string

Data de expiração no formato ISO 8601.

externalReference

string

Referência externa do seu sistema para rastreio.

attemptIdempotencyKey

string

Chave de idempotência para a tentativa. Reuso da mesma chave retorna 409.

webhookUrl

string

URL chamada quando a cobrança for paga (POST com payload).

gatewayOptions

object

Mostrar Campos

redirectUrl

string

URL de retorno após pagamento (Revolut).

expireAt

string

Expiração da tentativa no gateway (ISO 8601).

customerMeta

object

Dados do cliente. Usados pelos gateways quando não forem substituídos no momento do pagamento.

Mostrar Campos

name

string

Nome do cliente.

string

E-mail do cliente.

document

string

Documento (CPF/CNPJ).

document_type

string

Tipo do documento.

phone

string

Telefone.

source

string

Origem (PRE_FILLED ou COLLECT_AT_CHECKOUT).

split

array

Novo Lista de destinatários para split de pagamento. Omitir este campo cria a cobrança sem split.

Mostrar Campos de cada item

string

obrigatório

E-mail do destinatário cadastrado na plataforma.

O destinatário precisa ter uma conta ativa na plataforma como usuário CUSTOMER. Emails não encontrados ou de usuários com outro perfil caem como residual para o dono da cobrança — não bloqueia a criação, mas o valor não será repassado ao destinatário pretendido.

kind

string

obrigatório

Tipo do split:

FIXED — valor fixo em reais (informe amount). Soma dos itens FIXED deve ser ≤ grossAmount.
PERCENT — percentual sobre o netAmount (informe percent). Soma dos itens PERCENT deve ser ≤ 100.

amount

string

Valor fixo em reais (ex.: "50.00"). Obrigatório quando kind = FIXED.

percent

number

Percentual de 0.01 a 100. Obrigatório quando kind = PERCENT.

Response

string

Sem paymentMethod: ID da cobrança. Com paymentMethod: ID da tentativa (o ID da cobrança vai em chargeId).

chargeId

string

ID da cobrança (presente apenas quando a resposta é uma tentativa).

status

string

PENDING / PROCESSING / PAID / EXPIRED / CANCELED / FAILED / REFUNDED.

paymentMethod

string

PIX ou INTERNATIONAL (presente apenas quando há tentativa).

grossAmount

string

Valor bruto da cobrança (2 casas decimais).

currency

string

Moeda da cobrança (ISO 4217).

checkoutMeta

object

Instruções para o front concluir o pagamento.

Mostrar Campos

url

string

URL pública do checkout.

paymentMethod

string

Método (PIX / INTERNATIONAL).

qr_image

string

Base64 da imagem QR (PIX apenas).

qr_text

string

BR Code PIX em texto (PIX apenas).

emv

string

EMV PIX (PIX apenas).

integrationToken

string

Token público para inicializar o Revolut Checkout Web SDK (INTERNATIONAL apenas).

currency

string

Moeda do checkout (INTERNATIONAL apenas).

fxMeta

object

Conversão cambial aplicada (INTERNATIONAL apenas).

Mostrar Campos

fromCurrency

string

BRL.

toCurrency

string

Moeda destino (ex.: USD).

rate

number

Taxa aplicada.

originalAmount

number

Valor original em BRL.

convertedAmount

number

Valor convertido.

amountWithSpread

number

Valor final cobrado (com spread).

amountCents

number

Valor final em centavos.

fetchedAt

string

Momento da cotação.

expiresAt

string

Data de expiração.

description

string

Descrição da cobrança.

externalReference

string

Referência externa.

customerMeta

object

Dados do cliente.

splitConfig

array

Configuração de split informada na criação (presente quando split[] foi enviado).

Mostrar Campos

string

E-mail do destinatário.

kind

string

FIXED ou PERCENT.

amount

string

Valor fixo em reais (FIXED).

percent

number

Percentual (PERCENT).

splitSettlement

array

Liquidação calculada: quanto cada destinatário recebe. O “troco” de arredondamento (PERCENT) sempre vai para o dono.

Mostrar Campos

userId

number

ID do usuário na plataforma.

amountCents

number

Valor que o usuário receberá (centavos).

isOwner

boolean

true quando for o dono da cobrança.

sourceEmail

string

E-mail do destinatário.

createdAt

string

Data de criação (ISO 8601).

updatedAt

string

Data de atualização (ISO 8601).

curl -X POST "https://api.gates2b.com/charge" \
  -H "Authorization: Bearer {your-token}" \
  -H "Content-Type: application/json" \
  -d '{
    "grossAmount": "10.50",
    "currency": "BRL",
    "description": "Test charge",
    "expiresAt": "2030-12-31T23:59:59.000Z",
    "externalReference": "pedido-123",
    "customerMeta": {
      "name": "Cliente Exemplo",
      "email": "cliente@example.com",
      "source": "PRE_FILLED"
    }
  }'

{
  "id": "01KPQ3EG70VJ22B7B5VDKCPN7H",
  "userId": 222,
  "kind": "SALE",
  "status": "PENDING",
  "grossAmount": "10.50",
  "netAmount": "10.45",
  "sharedAmount": "0.00",
  "disputeReserve": "0.00",
  "refundedAmount": "0.00",
  "currency": "BRL",
  "description": "Test charge",
  "externalReference": "pedido-123",
  "expiresAt": "2030-12-31T23:59:59.000Z",
  "customerMeta": {
    "name": "Cliente Exemplo",
    "email": "cliente@example.com",
    "source": "PRE_FILLED"
  },
  "webhookUrl": null,
  "feesMeta": { "fees": "..." },
  "createdAt": "2026-04-21T01:05:49.924Z",
  "updatedAt": "2026-04-21T01:05:49.924Z"
}

Criar Tentativa Avulsa

POST /charge/{chargeId}/attempts Cria uma tentativa de pagamento para uma cobrança existente (server-side, autenticado via JWT). Aceita PIX e INTERNATIONAL.

Parâmetro	Tipo	Obrigatório	Descrição
`paymentMethod`	string	Sim	`PIX` ou `INTERNATIONAL`
`currency`	string	Condicional	Moeda de destino (obrigatório para `INTERNATIONAL`, ISO 4217)
`redirectUrl`	string	Não	URL de retorno (usado em INTERNATIONAL)
`attemptIdempotencyKey`	string	Não	Chave de idempotência (recomendado)

curl -X POST "https://api.gates2b.com/charge/{chargeId}/attempts" \
  -H "Authorization: Bearer {your-token}" \
  -H "Content-Type: application/json" \
  -d '{
    "paymentMethod": "PIX",
    "attemptIdempotencyKey": "uuid-v4"
  }'

Informações Básicas

API Key

Cobrança

PIX

Cartão de Crédito

Crypto

Reembolsos

Webhooks

Parâmetros

Response

Criar Tentativa Avulsa

Informações Básicas

API Key

Cobrança

PIX

Cartão de Crédito

Crypto

Reembolsos

Webhooks

Documentation Index

​Parâmetros

​Response

​Criar Tentativa Avulsa

Parâmetros

Response

Criar Tentativa Avulsa