Depósitos

Consultá los depósitos que recibió tu comercio o los que aún están pendientes.

Consultar depósitos

Recibidos:

POST /deposits/paid/page/0

Pendientes:

POST /deposits/pending/page/0

Headers

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

Request Body

{}

Response

200 OK

{
    "page": "number",
    "existMore": "boolean",
    "listTrx": [
        {
            "_id": "string",
            "amount": "number",
            "dateTime": "string",
            "currency": "string",
            "commission": {
                "name": "string",
                "value": "number"
            },
            "commissionAmount": "number",
            "commissionAndFinancialCostAmount": {
                "name": "string",
                "value": "number"
            },
            "commissionAndFinancialCostTaxAmount": {
                "name": "string",
                "value": "number"
            },
            "commissionTaxAmount": "number",
            "costPerInstallment": "number",
            "financialCostTaxAmount": "number",
            "withholdingTax": "number",
            "withholdingTaxAmount": "number",
            "total": "number",
            "state": "string",
            "toDeposit": "string"
        }
    ]
}

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"
}

Aquí algunos ejemplos de peticiones:

cURL

curl --location --request POST 'http://api-gwt.sipago.online/services/deposits/paid/page/0' \
--header 'apikey: su_api_key' \
--header 'X-TRACE-ID: uuidv4()' \
--header 'X-VERSION: 1' 

NodeJs - Axios

const axios = require('axios');

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'http://gapi-gwt.sipago.online/services/deposits/paid/page/0',
  headers: { 
    'apikey': 'su_api_key', 
    'X-TRACE-ID': 'uuid'
  }
};

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

Python - Requests

import requests

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

payload = {}
headers = {
  'apikey': 'su_api_key',
  'X-TRACE-ID': 'uuid'
}

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

print(response.text)