API Webhook Notification Documentation
This document provides the technical connectivity details of the webhook API that our client must implement for receiving notifications of incoming transactions from SINPE.
As a technical requirement, it is requested that the service be exposed via HTTPS and that TLS 3.1 or higher be implemented. Additionally, it is recommended (but not mandatory) to whitelist the public IP of SOLFIN (provided during implementation).
Endpoint
- URL: (To be provided by the client)
- Method: POST
- Header: apiKey: (To be provided by the client)
API Request Attributes
id
| Description | Type | Example |
|---|---|---|
| Unique identifier for the transaction. | number | 1082 |
movementType
| Description | Type | Possible Values | Example |
|---|---|---|---|
| Type of the movement. | string | C - CreditD - Debit | C |
idTransaction
| Description | Type | Example |
|---|---|---|
| Unique identifier for the transaction in the system. | string | 2024082310283005006122749 |
ref
| Description | Type | Example |
|---|---|---|
| Reference code for the transaction. | string | 2024082310283005006122749 |
transactionType
| Description | Type | Possible Values | Example |
|---|---|---|---|
| Type of transaction. | number | 1 - Pagos Inmediatos (PIN)2 - Débitos en Tiempo Real (DTR)4 - Cámara de Créditos Directos (CCD)8 - SINPE Móvil (PMB) | 8 |
description
| Description | Type | Example |
|---|---|---|
| Description of the transaction. | string | 01-2345-6789 | RAUL_PEREZ | 0 | Sin Descripcion |
amount
| Description | Type | Example |
|---|---|---|
| Amount involved in the transaction. | number | 100 |
currency
| Description | Type | Possible Values | Example |
|---|---|---|---|
| Currency used for the transaction. | string | CRC - Costa Rican Colón | CRC |
accountTo
| Description | Type | Example |
|---|---|---|
| Destination account number for the transaction. | string | CR93084502100000333333 |
phone
| Description | Type | Example |
|---|---|---|
| Phone number associated with the transaction. | string | 88888888 |
sinpeServiceNumber
| Description | Type | Possible Values | Example |
|---|---|---|---|
| Service number for SINPE (National Electronic Payment System). | string | 22 - Pagos Inmediatos (PIN)24 - Débitos en Tiempo Real (DTR)31 - Cámara de Créditos Directos (CCD)83 - SINPE Móvil (PMB) | 83 |
createdAt
| Description | Type | Example |
|---|---|---|
| Timestamp when the transaction was created. | string (ISO 8601 format) | 2024-08-23 15:40:31 |
updatedAt
| Description | Type | Example |
|---|---|---|
Timestamp when the transaction was last updated. null if not updated. | string or null | null |
additionalParams
| Description | Type |
|---|---|
| Additional parameters related to the transaction in JSON format. | string (JSON) |
JSON Format for additionalParams
| Type | Value |
|---|---|
PMB | "CelularOrigen": "", - IF THE TRANSACTION WAS TRIGGERED FROM AN UNAUTHENTICATED CHANNEL (SMS), 0 IF DEFAULT VALUE"CelularDestino": "", - DESTINATION WALLET WHERE THE INCOMING FUNDS WERE CREDITED"CodReferenciaCanal": "", - INTERNAL SYSTEM REFERENCE CODE OR SINPE REFERENCE NUMBER"NomDestino": "", - NAME OF THE DESTINATION WALLET OWNER"NomOrigen": "", - NAME OF THE ORIGINATOR OF THE TRANSFER"IdOrigen": "", - ID OF THE ORIGINATOR OF THE TRANSFER"IdDestino": "", - ID OF THE DESTINATION WALLET OWNER"TipoTransferencia": "" - INDICATES IF THE TRANSACTION IS INCOMING (2) |
Example JSON Request
{
"id": 1082,
"movementType": "C",
"idTransaction": "2024082310283005006222222",
"ref": "2024082310283005006222222",
"transactionType": 8,
"description": "01-2345-6789 | RAUL_PEREZ | 0 | Sin Descripcion",
"amount": 100,
"currency": "CRC",
"accountTo": "CR59084502100011111111",
"phone": "88888888",
"sinpeServiceNumber": "83",
"createdAt": "2024-08-23 15:40:31",
"updatedAt": null,
"additionalParams": "{\"CelularOrigen\":\"0\",\"CelularDestino\":\"88888888\",\"CodReferenciaCanal\":\"2024082310283005006222222\",\"NomDestino\":\"ABNER TORRES\",\"NomOrigen\":\"RAUL PEREZ \",\"IdOrigen\":\"01-2345-6789\",\"IdDestino\":\"01-9876-5432\",\"TipoTransferencia\":\"2\"}"
}