Referencia API

Iniciar pago del donativo

Inicializa donativo mediante campaña aprobada y servicio existente con idempotencia duradera.

POSThttps://api.sparkglim.net/api/white-label/v1/fundraising/initialize

Modelo de acceso

Modelo de acceso: HMAC de Organización en el servidor
Permiso requerido: payments:write
Disponibilidad documentada: Implementado en código

Disponibilidad verificada en el código, sin garantía de producción.

La firma privada permanece en su servidor. La API Versión 1 usa firma v2; no es una API v2.

Encabezados

Nombre	Tipo	Validación
`x-white-label-domain`Obligatorio Dominio verificado que resuelve la cuenta de Organización aprobada y vincula esta solicitud.	`string`	Validación: Nombre de host HTTPS verificado.
`x-white-label-key-id`Obligatorio Identificador extraído de la clave privada única; nunca envíe el secreto en esta cabecera.	`string`	Validación: Identificador interno de la clave privada emitida.
`x-white-label-signature-version`Obligatorio Selecciona la firma vinculada al dominio; las rutas API siguen en Versión 1.	`string`	Validación: 2.
`x-white-label-timestamp`Obligatorio Momento de firma en milisegundos comparado con el reloj del servidor para rechazar solicitudes caducadas.	`string`	Validación: Milisegundos de 13 dígitos; dentro de cinco minutos.
`x-white-label-nonce`Obligatorio Valor aleatorio nuevo registrado por el servidor para impedir repetir una solicitud firmada.	`string`	Validación: Valor nuevo: 16–128 [A-Za-z0-9_-].
`x-white-label-signature`Obligatorio HMAC-SHA256 de dominio, clave de idempotencia, credencial de campaña, instante, nonce, método, ruta, consulta ordenada y hash exacto del cuerpo.	`string`	Validación: HMAC-SHA256 hexadecimal en minúsculas.
`x-white-label-campaign-key`Opcional Clave de campaña completa opcional que limita la solicitud privada a la misma campaña autorizada.	`string`	Validación: Valor keyId:secret completo, opcional y limitado a su ámbito.
`X-Idempotency-Key`Obligatorio Identidad estable de operación reutilizada con los mismos detalles; cambiar detalles con la misma clave se rechaza.	`string`	Validación: 16–128 [A-Za-z0-9_-].

Solicitud

Nombre	Tipo	Validación
`campaignId`Obligatorio Campaña existente dentro de la cuenta y del alcance más limitado de la credencial.	`string`	Validación: UUID.
`amount`Obligatorio Importe solicitado en la moneda de campaña o cuenta; el servidor valida autoridad financiera y condiciones finales.	`number`	Validación: Valor positivo; el servidor valida la moneda de campaña.
`callbackUrl`Obligatorio Destino de retorno aceptado por el contrato; nunca demuestra éxito del pago.	`string`	Validación: URL.
`phoneNumber`Opcional Teléfono del participante; métodos y reglas pueden exigir número internacional válido.	`string\|null`	Validación: 8–32.
`email`Opcional Correo de contacto usado por el flujo configurado; por sí solo no concede acceso.	`string\|null`	Validación: Correo electrónico.
`donorName`Opcional Nombre visible del miembro o colaborador; no cambia propiedad de cuenta.	`string\|null`	Validación: <=160.
`displayName`Opcional Nombre visible del miembro o colaborador; no cambia propiedad de cuenta.	`string\|null`	Validación: <=160.
`anonymous`Opcional Solicita contribución anónima existente; no envíe campos contradictorios.	`boolean`	Validación: Valor predeterminado: false.
`message`Opcional Mensaje opcional conservado con donativo según presentación permitida.	`string\|null`	Validación: <=1000.
`channel`Opcional Canal de entrega o integración admitido por operación y configuración habilitada.	`enum`	Validación: web \| ussd \| telegram \| whatsapp.
`payment_channel`Opcional Preferencia opcional; solo se usan métodos habilitados para país vendedor, moneda y comercio reales.	`enum`	Validación: Método de pago habilitado.
`metadata`Opcional Metadatos JSON admitidos; nunca sustituyen autorización, precios o propiedad.	`object`	Validación: Objeto JSON.

Solicitud

Los ejemplos describen el contrato y no se ejecutan. Use registros de prueba autorizados; nunca pegue secretos reales aquí.

POST /api/white-label/v1/fundraising/initialize

http

POST /api/white-label/v1/fundraising/initialize HTTP/1.1
Host: api.sparkglim.net
x-white-label-domain: events.example.com
x-white-label-key-id: <ISSUED_KEY_ID>
x-white-label-signature-version: 2
x-white-label-timestamp: <FRESH_MILLISECONDS>
x-white-label-nonce: <FRESH_SIGNING_NONCE>
x-white-label-signature: <SERVER_GENERATED_SIGNATURE>
X-Idempotency-Key: example_stable_operation_0001
Content-Type: application/json

{
  "campaignId": "11111111-1111-4111-8111-111111111111",
  "amount": 10,
  "callbackUrl": "https://events.example.com/payment-return",
  "anonymous": true
}

Respuesta

Respuesta correcta · HTTP 200

json

{
  "success": true,
  "data": {
    "authorization_url": "https://checkout.sparkglim.net/gh/<SERVER_REFERENCE>",
    "reference": "<SERVER_REFERENCE>"
  },
  "requestId": "wlapi_example"
}

Respuesta de error · HTTP 400

json

{
  "success": false,
  "error": "<ERROR_MESSAGE>",
  "requestId": "wlapi_example"
}

Validación, permisos, registros no disponibles y fallos usan el estado HTTP y error del controlador.

Límites y reintentos

Organización: 120 solicitudes por clave y 300 por IP por ventana; respete Retry-After y X-RateLimit.

Compatibilidad del código

Las operaciones autorizadas requieren pruebas específicas de la cuenta.

server/src/api/router.ts
server/src/api/routes/white-label.ts
server/src/white-label/auth.ts
server/src/white-label/schemas.ts
server/src/white-label/organization-service.ts
server/src/white-label/service.ts

Modelo de acceso

Encabezados

Solicitud

Solicitud

Respuesta

Límites y reintentos

Compatibilidad del código

Seguir desarrollando