Pular para o conteúdo principal
POST
/
payments
/
v1
/
card
curl -X POST "https://api.gates2b.com/payments/v1/card" \
  -H "Authorization: Bearer {seu-token}" \
  -H "Content-Type: application/json" \
  -d '{
    "clientMode": "noNeedToSpecify",
    "amount": 3.05,
    "expire_at": "2025-12-30T03:00:00.000Z",
    "installments": 12
  }'

{
  "id": 3577,
  "amount": 3.05,
  "description": null,
  "clientMode": "noNeedToSpecify",
  "redirect_url": null,
  "email": null,
  "phoneNumber": null,
  "document_type": null,
  "expire_at": "2025-12-30T03:00:00.000Z",
  "document_client": null,
  "document_type_client": null,
  "name_client": null,
  "id_transaction": "7ddc71cb-66a8-4c48-b509-706b2db0e37a",
  "emv": null,
  "name_receiver": "Clever Meireles Lopes Junior",
  "international_status": "WAITING_PAYMENT",
  "status": "Aguardando pagamento",
  "checkout_id": 1,
  "checkout_url": "https://pay.gates2b.com/7ddc71cb-66a8-4c48-b509-706b2db0e37a",
  "createdAt": "2025-12-10T19:53:09.078Z",
  "updatedAt": "2025-12-10T19:53:09.078Z",
  "installments": 12
}

Documentation Index

Fetch the complete documentation index at: https://docs.gates2b.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Authorization
string
obrigatório
O token de autenticação no formato Bearer é obrigatório para acessar este endpoint.
​
clientMode
string
obrigatório
Define o modo de tratamento dos dados do cliente. - noNeedToSpecify: Não exige dados do cliente. - fillDataNow: Dados do cliente devem ser fornecidos agora. - requestCheckout: Dados do cliente serão preenchidos via checkout.
​
amount
number
obrigatório
Valor do pagamento.
​
expire_at
string
obrigatório
Data e hora de expiração no formato ISO 8601.
​
installments
number
obrigatório
Número de parcelas do pagamento (1 a 24).

​
Response

​
id
number
ID único da transação criada.
​
amount
number
Valor do pagamento.
​
description
string
Descrição do pagamento.
​
clientMode
string
Modo de tratamento dos dados do cliente.
​
redirect_url
string
URL de redirecionamento após pagamento.
​
email
string
E-mail do cliente.
​
phoneNumber
string
Número de telefone do cliente.
​
document_type
string
Tipo de documento do cliente.
​
expire_at
string
Data e hora de expiração da transação.
​
document_client
string
Documento do cliente.
​
document_type_client
string
Tipo de documento do cliente.
​
name_client
string
Nome do cliente.
​
id_transaction
string
ID da transação (UUID).
​
emv
string
Dados EMV do cartão (quando aplicável).
​
name_receiver
string
Nome do recebedor.
​
international_status
string
Status internacional da transação. Valores possíveis: - WAITING_PAYMENT: Aguardando pagamento - PAID: Pago - DENIED: Negado - CANCELED: Cancelado
  • REFUNDED: Reembolsado
​
status
string
Status da transação em português.
​
checkout_id
number
ID do checkout gerado.
​
checkout_url
string
URL do checkout onde o cliente pode preencher os dados do cartão.
​
createdAt
string
Data e hora de criação da transação (formato ISO 8601).
​
updatedAt
string
Data e hora da última atualização (formato ISO 8601).
​
installments
number
Número de parcelas configuradas.
curl -X POST "https://api.gates2b.com/payments/v1/card" \
  -H "Authorization: Bearer {seu-token}" \
  -H "Content-Type: application/json" \
  -d '{
    "clientMode": "noNeedToSpecify",
    "amount": 3.05,
    "expire_at": "2025-12-30T03:00:00.000Z",
    "installments": 12
  }'

{
  "id": 3577,
  "amount": 3.05,
  "description": null,
  "clientMode": "noNeedToSpecify",
  "redirect_url": null,
  "email": null,
  "phoneNumber": null,
  "document_type": null,
  "expire_at": "2025-12-30T03:00:00.000Z",
  "document_client": null,
  "document_type_client": null,
  "name_client": null,
  "id_transaction": "7ddc71cb-66a8-4c48-b509-706b2db0e37a",
  "emv": null,
  "name_receiver": "Clever Meireles Lopes Junior",
  "international_status": "WAITING_PAYMENT",
  "status": "Aguardando pagamento",
  "checkout_id": 1,
  "checkout_url": "https://pay.gates2b.com/7ddc71cb-66a8-4c48-b509-706b2db0e37a",
  "createdAt": "2025-12-10T19:53:09.078Z",
  "updatedAt": "2025-12-10T19:53:09.078Z",
  "installments": 12
}

​
Observações Importantes

​
Status da Transação

Após a criação, a transação fica com status WAITING_PAYMENT (Aguardando pagamento). Os possíveis status são:
  • WAITING_PAYMENT: Aguardando pagamento
  • PAID: Pagamento aprovado e processado
  • DENIED: Pagamento recusado
  • CANCELED: Transação cancelada
  • REFUNDED: Pagamento reembolsado

​
Checkout URL

A checkout_url retornada pode ser usada para direcionar o cliente a uma página de checkout hospedada, onde ele pode preencher os dados do cartão de forma segura.

​
Parcelamento

  • Parcelas Disponíveis: 1 a 24 parcelas
  • Valor Mínimo: Consulte configuração específica da sua conta
  • Taxas: Calculadas automaticamente baseadas na configuração e número de parcelas

​
Client Mode

O campo clientMode define como os dados do cliente serão tratados:
  • noNeedToSpecify: Não exige dados do cliente no momento da criação
  • fillDataNow: Dados do cliente devem ser fornecidos no payload
  • requestCheckout: Dados do cliente serão preenchidos via checkout

​
Expiração

A data de expiração (expire_at) deve ser fornecida no formato ISO 8601. Após a expiração, a transação não poderá mais ser paga.

​
Códigos de Status HTTP

  • 201: Pagamento criado com sucesso
  • 400: Dados inválidos no payload
  • 401: Token de autenticação ausente ou inválido
  • 500: Erro interno ao criar pagamento

​
Validações

  1. Valor: Deve ser maior que 0
  2. Parcelas: Deve estar entre 1 e 24
  3. Data de Expiração: Deve ser uma data futura

​
Boas Práticas

  1. Armazene o ID da Transação: Guarde o id_transaction no seu banco de dados junto com o pedido 2. Checkout URL: Use a checkout_url para redirecionar o cliente ao checkout seguro 3. Webhook: Configure webhooks para receber notificações sobre mudanças de status 4. Expiração: Defina um tempo de expiração adequado (ex: 30 minutos, 24 horas) 5. Parcelamento: Considere o impacto das taxas ao definir o número de parcelas