Saltar al contenido principal
POST
https://api.gates2b.com
/
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
}
​
Authorization
string
requerido
El token de autenticacion en formato Bearer es obligatorio para acceder a este endpoint.
​
clientMode
string
requerido
Define el modo de tratamiento de los datos del cliente. - noNeedToSpecify: No requiere datos del cliente. - fillDataNow: Los datos del cliente deben ser enviados ahora. - requestCheckout: Los datos del cliente se completaran via checkout.
​
amount
number
requerido
Valor del pago.
​
expire_at
string
requerido
Fecha y hora de expiracion en formato ISO 8601.
​
installments
number
requerido
Numero de cuotas del pago (1 a 24).

​
Response

​
id
number
ID unico de la transaccion creada.
​
amount
number
Valor del pago.
​
description
string
Descripcion del pago.
​
clientMode
string
Modo de tratamiento de datos del cliente.
​
redirect_url
string
URL de redireccion despues del pago.
​
email
string
Correo del cliente.
​
phoneNumber
string
Numero de telefono del cliente.
​
document_type
string
Tipo de documento del cliente.
​
expire_at
string
Fecha y hora de expiracion de la transaccion.
​
document_client
string
Documento del cliente.
​
document_type_client
string
Tipo de documento del cliente.
​
name_client
string
Nombre del cliente.
​
id_transaction
string
ID de la transaccion (UUID).
​
emv
string
Datos EMV de la tarjeta (cuando aplica).
​
name_receiver
string
Nombre del receptor.
​
international_status
string
Estado internacional de la transaccion. Valores posibles: - WAITING_PAYMENT: Esperando pago - PAID: Pagado - DENIED: Rechazado - CANCELED: Cancelado
  • REFUNDED: Reembolsado
​
status
string
Estado de la transaccion en portugues.
​
checkout_id
number
ID del checkout generado.
​
checkout_url
string
URL del checkout donde el cliente puede completar los datos de la tarjeta.
​
createdAt
string
Fecha y hora de creacion de la transaccion (formato ISO 8601).
​
updatedAt
string
Fecha y hora de la ultima actualizacion (formato ISO 8601).
​
installments
number
Numero de cuotas 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
}

​
Observaciones Importantes

​
Estado de la Transaccion

Tras la creacion, la transaccion queda con estado WAITING_PAYMENT (Esperando pago). Los posibles estados son:
  • WAITING_PAYMENT: Esperando pago
  • PAID: Pago aprobado y procesado
  • DENIED: Pago rechazado
  • CANCELED: Transaccion cancelada
  • REFUNDED: Pago reembolsado

​
URL de Checkout

La checkout_url devuelta puede usarse para dirigir al cliente a una pagina de checkout alojada, donde puede completar los datos de la tarjeta de forma segura.

​
Cuotas

  • Cuotas disponibles: 1 a 24 cuotas
  • Monto minimo: Consulta la configuracion especifica de tu cuenta
  • Tarifas: Calculadas automaticamente segun la configuracion y numero de cuotas

​
Client Mode

El campo clientMode define como se trataran los datos del cliente:
  • noNeedToSpecify: No requiere datos del cliente al crear
  • fillDataNow: Los datos del cliente deben enviarse en el payload
  • requestCheckout: Los datos del cliente se completaran via checkout

​
Expiracion

La fecha de expiracion (expire_at) debe enviarse en formato ISO 8601. Despues de la expiracion, la transaccion ya no puede pagarse.

​
Codigos de Estado HTTP

  • 201: Pago creado con exito
  • 400: Datos invalidos en el payload
  • 401: Token de autenticacion ausente o invalido
  • 500: Error interno al crear el pago

​
Validaciones

  1. Monto: Debe ser mayor que 0
  2. Cuotas: Debe estar entre 1 y 24
  3. Fecha de expiracion: Debe ser una fecha futura

​
Buenas Practicas

  1. Guarda el ID de Transaccion: Guarda el id_transaction en tu base de datos junto con el pedido 2. Checkout URL: Usa checkout_url para redirigir al cliente al checkout seguro 3. Webhook: Configura webhooks para recibir notificaciones de cambios de estado 4. Expiracion: Define un tiempo de expiracion adecuado (ej: 30 minutos, 24 horas) 5. Cuotas: Considera el impacto de las tarifas al definir el numero de cuotas