API Deposits Query

The PixelPay Deposit Inquiry API is a simple way to obtain the movements in your bank account.

ℹ️ Between the hours of 7:00 p.m. to 7:00 a.m. the service is 
available but no updates are made to the entries.

1. Requirements and Preparation
To get started, you need to have access to an account with API Settings permissions or be the account administrator.
2. Key removal
In order to do this integration, you will need to obtain the Key ID and Secret Key from your PixelPay platform (endpoint and key extraction). The bucket query HTTP headers are included as follows:

x-auth-key: <Key ID del comercio>
x-secret: <Secret Key del comercio>
x-auth-hash: <MD5 del Secret Key del comercio>
Accept: application/json

3. Query and Parameters
In order to do this integration, you need to send an HTTP GET (Endpoint and Key Extraction) request to the URL:

https://{endpoint}/api/v2/deposits?<parámetros>

The following parameters must be sent through the URL:

Field	Value	Description
filter_from	2024-02-01T15:12:43-06:00	Start date and time for filtering deposits in ISO 8601 format
filter_to	2024-03-15T15:12:43-06:00	End date and time for filtering deposits in ISO 8601 format
filter_by	created_at	Field by which to filter deposits can be: "booked_at", "valued_at", "created_at", "updated_at"

4. Example
Example of URL with parameters:

https://pixelpay.app/api/v2/deposits?filter_from=2024-02-01T15:12:43-06:00&filter_to=2024-03-15T15:12:43-06:00&filter_by=created_at

Example response:

{
"success": true,
"message": "Información obtenida con exito",
"data": [
{
"ref": "MT103-123",
"amount": "200.00",
"currency": "HNL",
"type": "DEBIT",
"code": "NTRF",
"status": "PENDING",
"description": "/T-S02203 Nombre cliente d",
"reporting": "mt942",
"extra": {
"internal_transaction_code": "WD"
},
"booked_at": null,
"valued_at": "2024-02-19T18:29:44.000000Z",
"created_at": "2024-02-27T18:29:44.000000Z",
"updated_at": "2024-02-27T18:29:44.000000Z",
"total_formatted": "L 200.00"
},
{
"ref": "390300602",
"amount": "260.40",
"currency": "HNL",
"type": "CREDIT",
"code": "NMSC",
"status": "BOOK",
"description": "PP INV TRN DIA TRX 5",
"reporting": "camt.053.001.08",
"extra": null,
"booked_at": "2024-02-05T06:00:00.000000Z",
"valued_at": "2024-02-05T06:00:00.000000Z",
"created_at": "2024-02-26T20:21:41.000000Z",
"updated_at": "2024-02-26T20:21:41.000000Z",
"total_formatted": "L 260.40"
},
{
"ref": "178",
"amount": "250.00",
"currency": "HNL",
"type": "DEBIT",
"code": "NTRF",
"status": "BOOK",
"description": "RobotAPI",
"reporting": "camt.053.001.08",
"extra": {
"end_to_end_id": "DOM12345"
},
"booked_at": "2024-02-05T06:00:00.000000Z",
"valued_at": "2024-02-05T06:00:00.000000Z",
"created_at": "2024-02-26T20:21:41.000000Z",
"updated_at": "2024-02-26T20:21:41.000000Z",
"total_formatted": "L 250.00"
}
]
}