La API de Payout de VirtualPOS opera a través de una API KEY y SECRET KEY, este conjunto de llaves son únicas para cada cuenta y ambiente (Sandbox o producción), y serán entregadas durante la ejecución del proyecto de integración.
La API KEY debe ser enviada en cada requerimiento en el encabezado Authorization.
Cada requerimiento debe ser firmado, y la firma debe ser incluida también en el encabezado (header del mensaje HTTP) Signature
La firma se genera utilizando la SECRET KEY y JSON Web Token (JWT). JWT es un estándar abierto (RFC 7519) que define una forma compacta y autónoma de transmitir información de forma segura entre las partes como un objeto JSON. Esta información se puede verificar y confiar porque está firmada digitalmente. Más información de este estándar lo puedes encontrar en https://jwt.io/
Para los métodos de:
- Crear una nueva instrucción de payout
- Consultar estado de payout por id
- Consultar estado de payout por merchant id
El Signature debe estar construido como un diccionario JSON con la siguiente estructura:
{
'api_key': "yourApiKey",
'tef': {
"merchant_id": "tef-XXXXX-XX",
"message": "Devolución de compra OC XXX",
"amount": 12500,
"recipient": {
"rut": "1111111-1",
"name": "John Doe",
"email": "[email protected]"
},
"bank": {
"sbif_code": "111",
"account_number": "11111111"
}
}
}
Asegúrese de proporcionar valores válidos y precisos para cada clave dentro del diccionario.
Descripción de las claves
- api_key: Su clave única de API para la autenticación.
- tef: Un objeto que contiene detalles específicos de la transacción.
- merchant_id: Identificación única del comerciante.
- message: Mensaje descriptivo asociado con la transacción.
- amount: Monto de la transacción.
- recipient: Detalles del destinatario.
- rut: RUT del destinatario, este debe ser ingresado sin puntos.
- name: Nombre del destinatario.
- email: Correo electrónico del destinatario.
- bank: Detalles bancarios.
- sbif_code: Código SBIF del banco.
- account_number: Número de cuenta bancaria.
- tef: Un objeto que contiene detalles específicos de la transacción.
Un ejemplo del Signature correctamente estructurado se presenta arriba. Asegúrese de seguir esta estructura al construir su propia firma digital para cada solicitud a la API