Efectivo
POST
Crear Transacción Cash
Genera un recibo de pago en efectivo para que el cliente cancele en un punto físico (Efecty, Baloto, Su Red, etc.). El cliente recibe un voucher con el código de pago.
POST
https://serviceregister.paymentsway.co/ClientAPI/CrearTransaccionCashSolo disponible para usuarios con certificación PCI y DSS. Obtén los métodos disponibles con ObtenerMediosDePago.
Headers
Envía tu Api_key en el header x-api-key.
Parámetros
| Campo | Tipo | Descripción | Req. |
|---|---|---|---|
amount | integer | Valor del pago en pesos colombianos. | Sí |
external_order | string | Referencia única de la transacción en tu sistema. | Sí |
description | string | Descripción breve de la orden. | Sí |
method | string | Método de pago en efectivo. Obtenido de ObtenerMediosDePago. Ej: efecty. | Sí |
iva | integer | IVA del pago. Si no aplica enviar 0. | Sí |
user_identification | string | Número de identificación del pagador. | Sí |
identification_type | string | Tipo de identificación: CC, CE, NIT, DNI. | Sí |
user_name | string | Nombre del pagador. | Sí |
user_last_name | string | Apellido del pagador. | Sí |
user_email | string | Email del pagador. | Sí |
user_phone | string | Celular del pagador. | Sí |
user_address | string | Dirección del pagador. | Sí |
terminal_id | integer | ID de la terminal. | Sí |
form_id | integer | ID del formulario/botón de pago. | Sí |
ip | string | Dirección IP del pagador. | Sí |
additionalData | object | Datos adicionales que se retornan en el webhook. | No |
Cuerpo de ejemplo
{
"amount" : 30000,
"external_order" : "ORD-CASH-001",
"description" : "Pago membresía mensual",
"method" : "efecty",
"iva" : 0,
"user_identification" : "1012345678",
"identification_type" : "CC",
"user_name" : "Andres",
"user_last_name" : "Camil",
"user_email" : "andres@example.com",
"user_phone" : "3227358312",
"user_address" : "Cra 8b 17 15",
"terminal_id" : 34,
"form_id" : 34,
"ip" : "192.168.0.1",
"additionalData" : { "ref": "valor" }
}Ejemplo de petición
const headers = new Headers();
headers.append("x-api-key", "TU_API_KEY");
headers.append("Content-Type", "application/json");
const res = await fetch(
"https://serviceregister.paymentsway.co/ClientAPI/CrearTransaccionCash",
{ method: 'POST', headers, body: JSON.stringify(body), redirect: 'follow' }
);
const resultado = await res.json();
// resultado.urlVoucher contiene el link al voucher de pago
console.log(resultado);GETObtener medios de pago
Retorna el listado de métodos de pago en efectivo habilitados (Efecty, Baloto, etc.). El campo method retornado aquí se envía directamente en Crear Transacción Cash.
POSTWebHook
Recibe notificaciones en tiempo real sobre el resultado de cada transacción. PaymentsWay hace un HTTP POST a tu endpoint cuando una transacción cambia de estado.