List Deposits
The GET /fundings/ method enables you to retrieve detailed information about any of your deposits (pay-ins). However, you can retrieve a list of SPEI® deposits made into your account and filter using specific SPEI® criteria like tracking key and sender or receiver CLABEs.
GET /spei/v2/deposits
/spei/v2/depositsThe GET /spei/v2/deposits method returns a cursor based paginated filtered list of SPEI® deposits made into the CLABEs linked to your account, ordered by date of creation, including reversed withdrawal deposits (refunds deposit). The cursor-based pagination allows for more efficient and reliable navigation through large datasets, ensuring you don't miss or duplicate records as new deposits are added.
When no query parameters are provided, the created_at_gte filter defaults to the start of the current day (today at 00:00:00 UTC). Details about the available filters and return contract are available in the API Reference.
Compensatory deposits
When a withdrawal is rejected by the destination institution, the banking system may issue a compensatory deposit back to the sender. Each compensatory deposit includes a refunded_withdrawal field with the information about the withdrawal that triggered it (wid, tracking_key and origin_id if available).
Multi-CLABE Failed Deposits
Table 1 outlines why a SPEI® deposit to a created CLABE or to complete a one-time payment might fail. Each error is represented as an object with a code and message in the errors array of the deposit response.
| Error Code | Description |
|---|---|
| clabe_disabled | The CLABE is currently disabled and cannot receive deposits. |
| clabe_blocked | The CLABE has been blocked and is unavailable for deposits. |
| minimum_limit_amount | The deposit amount falls below the minimum limit set for the CLABE. |
| deposit_maximum_operation_amount_exceeded | The deposit amount exceeds the maximum per-transaction limit for the CLABE. |
| deposit_maximum_daily_amount_exceeded | The deposit amount exceeds the maximum daily limit for the CLABE. |
| deposit_maximum_weekly_amount_exceeded | The deposit amount exceeds the maximum weekly limit for the CLABE. |
| deposit_maximum_monthly_amount_exceeded | The deposit amount exceeds the maximum monthly limit for the CLABE. |
| invalid_payment_amount | The deposit amount does not match the expected payment amount. |
| expired_payment | The one-time payment has expired and can no longer be completed. |
| payment_already_completed | The one-time payment has already been completed. |
Table 1. Reasons for Multi-CLABE Failed Deposits
Updated 8 months ago