List Deposits Made
The GET /spei/v1/deposits
method returns a paginated list of deposits that match the given query parameters. The search space considers only deposits made into CLABEs that belong to your account, including reversed withdrawal deposits (refund deposits).
When you do not specify any query parameters, it returns all the fundings made to all the CLABEs linked to your account.
To list the deposits made into your CLABEs, send the HTTP request as follows:
GET https://stage.buildwithjuno.com/spei/v1/deposits
The following table summarizes the optional query parameters you can use in a filtered search:
Query Parameter | Description | Required |
---|---|---|
clabe_type | The receiving CLABE type. Valid value: AUTO_PAYMENT . | No |
deposit_status | The deposit's standing. Valid values: COMPLETE , PENDING , and FAILED . | |
end_date | The ending date of the time window searched specified in ISO 8601 date format, YYYY-MM-DD (server timezone). It returns the deposits whose creation date lies on or before the defined date. Ensure the value of this parameter comes after the value of start_date if used together. | |
only_refunds | A Boolean flag to retrieve only refund deposits. | No |
page | The page number to retrieve, default value=1. | No |
page_size | The number of entries per page, default value = 25 and maximum value = 100. | No |
receiver_clabe | The CLABE that received the deposit. | No |
sender_clabe | The CLABE that sent the deposit. | No |
start_date | The starting date of the time window searched specified in ISO 8601 date format, YYYY-MM-DD (server timezone). It returns the deposits whose creation date lies on or after the defined date. Ensure the value of this parameter comes before the value of end_date if used together. | No |
timezone | Specifies a Coordinated Universal Time (UTC) offset that defines a timezone, enabling reporting transaction creation time according to the given timezone. A UTC offset is the difference in hours and minutes between UTC and the standard time at a particular place. UTC offsets range from the westernmost geographies (-12:00) to the easternmost (+14:00) and are a multiple of 15 minutes—however, the majority of times, they are stated in whole hours. Refer to the following list of UTC offsets to search for the ones of your regions of interest. Specify it using the following format: +[hh:mm], -[hh:mm], and [hh:mm]. Default value: 00:00. Examples: Argentina: -03:00 Colombia: -05:00 Sao Paulo: -03:00The date and time reported in the response for the created_at and updated_at keys are those of the specified timezone. Consider this conversion when using query parameters start_date and end_date together with timezone . See the Examples section for usage details. | No |
tracking_key | You can use this parameter to track a specific deposit using its clave_rastreo . However, it is especially helpful when searching for a specific refund deposit.Using the tracking key ( clave_rastreo ) returned by the webhook for the completed withdrawal, which eventually becomes a reversed withdrawal, you can search for a specific refund deposit.Refund deposits have the same clave_rastreo as the reversed withdrawal, so this key enables you to link them. An exception occurs when the service receives the refund deposit on a date different from the withdrawal's completion date. In this case, the clave_rastreo of both transactions does not match. However, this rarely occurs, but if it's your case, contact our Support Team at [email protected]. | No |
Examples
Example 1
The service stores all transactions in UTC but provides the timezone
parameter to display their creation dates in a specific time zone. For instance, to retrieve all transactions created on January 20th in Mexico's local time (UTC offset -06:00), configure the query parameters as follows:
This query adjusts the result set and the displayed timestamps based on the provided time zone. For example, a transaction recorded at 2025-01-20T14:38:34
(UTC) will be displayed as 2025-01-20T08:38:34
in the specified time zone (UTC-6). However, a transaction recorded at 2025-01-20T05:00:00
(UTC) is not included in the resulting set because, in the UTC-6 time zone, its creation date is 2025-01-19T23:00:00
.
Example 2
The following JSON object exemplifies the response returned using only a time window:
GET https://stage.buildwithjuno.com/spei/v1/deposits?start_date=2025-01-30&end_date=2025-02-07
{
"success": true,
"payload": {
"total_items": "2",
"total_pages": "1",
"current_page": "1",
"page_size": "25",
"response": [
{
"fid": "0b3dd045eada43afb41b2654f0a080f3",
"deposit_id": "4958772",
"sender_clabe": "810969123456765751",
"receiver_clabe": "710969123456324311",
"status": "complete",
"amount": "5000",
"currency": "mxn",
"details": {
"sender_name": "Sender Name",
"sender_bank": "97810",
"clave": "1738955111",
"clave_rastreo": "TESTSPEI674421738955111356",
"numeric_reference": "1",
"concepto": "Payment Reason",
"cep_link": null
},
"created_at": "2025-02-07T19:05:11",
"updated_at": "2025-02-07T19:05:12"
},
{
"fid": "2e9933c292aa4e51ac163375e1dffb0b",
"deposit_id": "4958752",
"sender_clabe": "810969123456765751",
"receiver_clabe": "710969123456324311",
"status": "complete",
"amount": "1000",
"currency": "mxn",
"details": {
"sender_name": "Sender Name",
"sender_bank": "97810",
"clave": "1738954967",
"clave_rastreo": "TESTSPEI674421738954967636",
"numeric_reference": "1",
"concepto": "Payment Reason",
"cep_link": null
},
"created_at": "2025-02-07T19:02:47",
"updated_at": "2025-02-07T19:02:48"
}
]
}
}
Response Parameters
Parameter Name | Definition |
---|---|
details > cep_link | The link to download the transaction receipt generated by Banxico. |
details > clave | The deposit ID supplied by the PRAXIS provider. |
details > clave_rastreo | The deposit ID assigned by Banxico. |
details > concepto | An alpha-numeric description of the transaction. |
details > numeric_reference | An identification number the sender provides that is useful to filter transactions, such as a date. Maximum length = 7 digits. |
details > sender_bank | Code of the financial institution that sent the deposit. |
details > sender_name | Name of the financial institution that sent the deposit. |
fid | The deposit (funding) unique ID. |
Updated 9 days ago