Guía de inicio rápido

Dato útil: Una guía de inicio rápido es ideal para que empieces a usar nuestra API en solo unos pocos pasos. Muchos desarrolladores prefieren sumergirse en lo esencial de inmediato, en lugar de leer detalladamente toda la documentación. ¡Así podés empezar a crear más rápido!

Obtené tus claves de API

Tus solicitudes a la API están autenticadas mediante claves de API. Cualquier solicitud que no incluya una clave de API devolverá un error.

Podés solicitar una clave de API contactando al equipo de Sipago.

Realizá tu primera solicitud

Base URL

http://api-gwt.sipago.online/services/

Para hacer tu primera solicitud, enviá una solicitud autenticada al endpoint de movimientos. Esto te devolverá la lista de movimientos para una fecha determinada.

Importante: Nunca expongas tu clave api en un repositorio público, ni la utilices en tu código client-side. Siempre hazlo de manera segura desde tu servidor.

Consultar movimientos

POST /transactions/page/0

Consultá la lista de tus movimientos para una fecha determinada.

Request Body

Name	Type	Description
startDate	date	Fecha desde
endDate	date	Fecha hasta

200 OK

{
    "page": "number",
    "existMore": "boolean",
    "listTrx": [
        {
            "_id": "number",
            "amount": "number",
            "dateTime": "string",
            "firstName": "string",
            "lastName": "string",
            "userId": "number",
            "taxes": [],
            "commission": {
                "rate": "number",
                "amount": "number"
            },
            "payment": {
                "paymentId": "number",
                "hash": "string",
                "method": "string",
                "totalAmount": "number",
                "hasRefund": "boolean",
                "canceled": "boolean",
                "cardNumber": "string",
                "cardHolderName": "string",
                "first5Numbers": "string",
                "last4Numbers": "string",
                "issuerName": "string",
                "issuerKey": "string",
                "paymentMethodId": "number",
                "name": "string",
                "es": "string",
                "en": "string",
                "paymentMethodType": "string",
                "adjustTipAvailable": "boolean",
                "issuerImageUrl": "string"
            },
            "authorizationCode": "string",
            "authenticationType": "string",
            "operationCode": "string",
            "operation": "string",
            "operationId": "number",
            "saleId": "number",
            "cardName": "string",
            "abr": "string",
            "device": "string",
            "buyer": {
                "id": "number",
                "name": "string",
                "buyerId": "number",
                "firstName": "string",
                "lastName": "string",
                "email": "string",
                "address": "string",
                "addressLine2": "string",
                "province": "string",
                "zipCode": "string",
                "birthdate": "string",
                "phone": "string",
                "city": "string",
                "document": "string",
                "documentType": "string",
                "countryId": "string",
                "occupation": "string",
                "country": "string"
            },
            "items": [
                {
                    "productId": "number",
                    "isCustomAmount": "boolean",
                    "quantity": "number",
                    "productPrice": "number",
                    "totalAmount": "number",
                    "productName": "string",
                    "productBackgroundColor": "string",
                    "productImageUrl": "string"
                }
            ],
            "canAnnulate": "boolean",
            "canAnnulateWithoutCard": "boolean",
            "canRefund": "boolean",
            "canRefundWithoutCard": "boolean",
            "canceled": "boolean"
        }
    ]
}

401 Unauthorized

// Si apikey no es enviado en el Headers: 
{"message":"Missing API key found in request"}

// Si apikey es enviada de forma errónea:
{"message":"Invalid API key in request"}

500 Internal Server Error

// Error de parámetros

{
   "status": 500,
   "message": "status 500",
   "timestamp": "2024-05-28T12:30:04Z"
}

Puede acceder a la API Sipago mediante curl o cualquier cliente HTTP.

curl

curl --location 'http://api-gwt.sipago.online/services/transactions/page/0' \
--header 'apikey: su_api_key' \
--header 'X-TRACE-ID: uuidv4()' \
--header 'X-VERSION: 1' \
--header 'Content-Type: application/json' \
--data '{"startDate":"2024-05-24","endDate":"2024-05-24"}'

NodeJs - Axios

const axios = require('axios');
let data = JSON.stringify({
  "startDate": "2024-05-24",
  "endDate": "2024-05-24"
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'http://api-gwt.sipago.online/services/transactions/page/0',
  headers: { 
    'apikey': 'su_api_key', 
    'X-TRACE-ID': '3cc1aabd-eb40-48bc-bb84-d1c34f1e2934', 
    'X-VERSION': '100', 
    'Content-Type': 'application/json'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

Python - Requests

import requests
import json

url = "http://api-gwt.sipago.online/services/transactions/page/0"

payload = json.dumps({
  "startDate": "2024-05-24",
  "endDate": "2024-05-24"
})
headers = {
  'apikey': 'su_api_key',
  'X-TRACE-ID': '3cc1aabd-eb40-48bc-bb84-d1c34f1e2934',
  'X-VERSION': '100',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)