Primeros pasosIntroducción

Introducción

Esta documentación presenta la API de pagos de la plataforma y describe cómo integrarla en tus sistemas. Aquí se detallan los endpoints, formatos de solicitud y respuestas necesarias para el uso de la API.

Descripción

La API utiliza el estándar REST y comunicación en JSON. Las solicitudes están organizadas para facilitar la implementación y mantener consistencia entre las operaciones disponibles.

Autenticación

Todas las solicitudes a la API deben autenticarse utilizando un token de acceso bajo el estándar Bearer Token.
Para obtener tus credenciales de API, accede a la página Finanzas → Integraciones en el panel de la plataforma.

Autenticación de las Rutas de Pago

En la página Finanzas → Integraciones, la clave necesaria para utilizar las rutas de pago se encuentra en la sección Credenciales de API.
Después de encontrar tu clave, inclúyela en el encabezado Authorization de la solicitud HTTP, siguiendo el formato Bearer <sua_chave_de_api>.

NODE

const routeUrl = "https://api.securitypag.com/v1/payment";
const apiToken = "Bearer " + "SUA_CHAVE_DE_API";

const payload = {
  amount: 25990,
  currency: "BRL",
  method: "PIX",
  description: "Pagamento de assinatura",
  externalRef: "order_98765",
  notificationUrl: "https://example.com/webhook/payment",
  payer: {
    name: "John Doe",
    taxId: "12345678901",
    email: "john.doe@example.com",
    phone: "11999999999",
  },
  "items": [
    {
      "quantity": 1,
      "name": "Produto Teste",
      "price": 1000,
      "type": "PHYSICAL"
    }
  ],
};

const response = await fetch(routeUrl, {
  method: "POST",
  headers: {
    Authorization: apiToken,
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

const data = await response.json();
console.log(data);

Autenticación de las Rutas de Transferencia

Para mayor seguridad, las rutas de transferencia utilizan una clave de API diferente.
En la página Finanzas → Integraciones, la clave necesaria para utilizar las rutas de transferencia se encuentra en la sección Credenciales de Retiro vía API.
Después de encontrar tu clave, inclúyela en el encabezado Authorization de la solicitud HTTP, siguiendo el formato Bearer <sua_chave_de_api>.

NODE

const routeUrl = "https://api.securitypag.com/v1/transfer";
const apiToken = "Bearer " + "SUA_CHAVE_DE_API_DE_SAQUE";

const payload = {
  "amount": 1000,
  "method": "PIX",
  "externalRef": "transfer_123",
  "notificationUrl": "https://example.com/webhook/transfer"
  "pix": {
    "pixKeyType": "EMAIL",
    "pixKey": "email@gmail.com"
  },
};

const response = await fetch(routeUrl, {
  method: "POST",
  headers: {
    Authorization: apiToken,
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

const data = await response.json();
console.log(data);

¿Algo mal en esta página? Habla con nosotros