Movimientos

Consultar movimientos

POST /transactions/page/0

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

Headers

Key	Value
Content-Type	application/json
apikey	su_api_key
X-TRACE-ID	uuidv4()
X-VERSION	1

Request Body

Name	Type	Description
startDate	date	Fecha desde
endDate	date	Fecha hasta

Response

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. Aquí algunos ejemplos de solicitud:

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)

Consultar movimientos por número de autorización

GET /transactions/code/:authorizationcode

Consultá el movimiento filtrando por número de autorización.

Params

Name	Type
authorizationcode	string

Headers

Key	Value
Content-Type	application/json
apikey	su_api_key
X-TRACE-ID	uuidv4()
X-VERSION	1

Response

200 OK

[
   {
            "_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. Aquí algunos ejemplos de solicitud:

curl

curl --location 'http://api-gwt.sipago.online/services/transactions/code/006417' \
--header 'apikey: su_api_key \
--header 'X-TRACE-ID: uuidv4()' \
--header 'X-VERSION: 1'

Consultar Orden

GET /checkout/getLink/:uuid

Consultá el movimiento filtrando por identificador uuid de la orden.

Params

Name	Type
uuid	string

Headers

Key	Value
Content-Type	application/json
apikey	su_api_key
X-TRACE-ID	uuidv4()
X-VERSION	1

Response

200 OK

[
  {
    "data": {
        "id": "string",
        "type": "string",
        "attributes": {
            "uuid": "string",
            "accountId": "number",
            "subsidiaryId": "number",
            "source": "string",
            "appId": "string",
            "paymentLimits": "number",
            "orderNumber": "string",
            "price": {
                "currency": "string",
                "amount": "number"
            },
            "shipping": null,
            "tip": null,
            "items": [
                {
                    "name": "string",
                    "quantity": "number",
                    "unitPrice": {
                        "currency": "string",
                        "amount": "number"
                    },
                    "itemId": null
                }
            ],
            "status": "string",
            "taxes": [],
            "externalData": {
                "user_uuid": "string",
                "checkout_url": "string",
                "referer": "string",
                "errorMessage": null
            },
            "links": {
                "checkout": "string",
                "redirect_url": {
                    "success": null,
                    "failed": null
                }
            },
            "hasPendingPayment": "boolean",
            "payment": {
                "id": "string",
                "authorization_code": "string",
                "reference_number": "string",
                "status": "string",
                "isRefunded": "boolean"
            },
            "payments": [
                {
                    "id": "string",
                    "authorization_code": "string",
                    "reference_number": "string",
                    "status": "string",
                    "isRefunded": "boolean"
                }
            ],
            "store": null,
            "billing": null
        },
        "links": [
            {
                "checkout": "string",
                "redirect_url": {
                    "success": null,
                    "failed": null
                }
            }
        ]
    }
}

]

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. Aquí algunos ejemplos de solicitud:

curl

curl --location 'http://api-gwt.sipago.online/services/checkout/getLink/99868576-6b2d-4e1b-8aae-784317301e46' \
--header 'apikey: su_api_key' \
--header 'X-TRACE-ID: uuidv4()' \
--header 'X-VERSION: 1'

nodejs

const axios = require('axios');

let config = {

method: 'get',

maxBodyLength: Infinity,

url: 'http://api-gwt.sipago.online/services/checkout/getLink/99868576-6b2d-4e1b-8aae-784317301e46',

headers: {

'apikey': 'su_api_key',

'X-TRACE-ID': 'uuidv4()',

'X-VERSION': '1'

}

};

axios.request(config)

.then((response) => {

console.log(JSON.stringify(response.data));

})

.catch((error) => {

console.log(error);

});

python

import requests

url = "http://api-gwt.sipago.online/services/checkout/getLink/99868576-6b2d-4e1b-8aae-784317301e46"

payload = {}

headers = {

'apikey': 'su_api_key',

'X-TRACE-ID': 'uuidv4()',

'X-VERSION': '1'

}

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

print(response.text)