Get Deposit by Batch Date

This method is called to fetch details of the individual deposits within a single batch and their current status. Results are filtered using Batch Date which was returned in the response of the Initiate Savings Deposit API call.

HTTP Method : GET
API Endpoint : {{base_url}}/api/v1/deposits/{{batchDate}}

Sample cURL Request

curl --location --request GET 'https://api.ovalfi-app.com/api/v1/deposits/2022-06-21'\
--header 'Authorization: Bearer eyJidXNpbmVzc0lEIjoiMjIzMzg3MzAtYWUyMC00MjM1LWJkMmMtYjVmY2Y3OTVjYWJhIiwia2V5IjoibGFsYXBhc3MifQ=='

📘
BatchDate
USD transactions are batched on a daily basis. To retrieve your batchDate, you can fetch it in the response of your initiate deposit request.

Response

{
    "status": 200,
    "data": {
        "deposits": [
            {
                "id": "7a8d9de2-fdfa-47bb-9e21-bbec688607a5",
                "customerID": "62fa5415-d7c0-4648-8e08-600a90bc95c9",
                "businessID": "d04319d7-b3fb-478e-ade5-76cc5176e1dd",
                "reference": "ref123",
                "amount": 50,
                "channel": "api",
                "createdAt": "2022-06-20T21:31:10.865938Z",
                "settledAt": {
                    "Time": "0001-01-01T00:00:00Z",
                    "Valid": false
                },
                "balanceBefore": 60,
                "balanceAfter": 110,
                "depositBeforeID": "cc3225b9-a58a-49b2-b4ab-c672cdb3fc9d",
                "batchDate": {
                    "Time": "2022-06-20T00:00:00Z",
                    "Valid": true
                },
                "status": "in_progress"
            },
            {
                "id": "b2210620-24b8-40df-a52b-922d114211ca",
                "customerID": "62fa5415-d7c0-4648-8e08-600a90bc95c9",
                "businessID": "d04319d7-b3fb-478e-ade5-76cc5176e1dd",
                "reference": "ref12",
                "amount": 50,
                "channel": "api",
                "createdAt": "2022-06-20T21:35:05.455023Z",
                "settledAt": {
                    "Time": "0001-01-01T00:00:00Z",
                    "Valid": false
                },
                "balanceBefore": 60,
                "balanceAfter": 110,
                "depositBeforeID": "cc3225b9-a58a-49b2-b4ab-c672cdb3fc9d",
                "batchDate": {
                    "Time": "2022-06-20T00:00:00Z",
                    "Valid": true
                },
                "status": "pending"
            },
            {
                "id": "c41fdc3a-ddb5-4ae5-b8c3-894ed891226b",
                "customerID": "62fa5415-d7c0-4648-8e08-600a90bc95c9",
                "businessID": "d04319d7-b3fb-478e-ade5-76cc5176e1dd",
                "reference": "ref124",
                "amount": 50,
                "channel": "api",
                "createdAt": "2022-06-20T21:37:29.459012Z",
                "settledAt": {
                    "Time": "0001-01-01T00:00:00Z",
                    "Valid": false
                },
                "balanceBefore": 110,
                "balanceAfter": 160,
                "depositBeforeID": "b2210620-24b8-40df-a52b-922d114211ca",
                "batchDate": {
                    "Time": "2022-06-20T00:00:00Z",
                    "Valid": true
                },
                "status": "pending"
            },
            {
                "id": "1a83bc3c-8e1d-4cb4-8e40-32cfb0f971d9",
                "customerID": "62fa5415-d7c0-4648-8e08-600a90bc95c9",
                "businessID": "d04319d7-b3fb-478e-ade5-76cc5176e1dd",
                "reference": "ref1245",
                "amount": 50,
                "channel": "api",
                "createdAt": "2022-06-20T21:45:17.062718Z",
                "settledAt": {
                    "Time": "0001-01-01T00:00:00Z",
                    "Valid": false
                },
                "balanceBefore": 160,
                "balanceAfter": 210,
                "depositBeforeID": "c41fdc3a-ddb5-4ae5-b8c3-894ed891226b",
                "batchDate": {
                    "Time": "2022-06-20T00:00:00Z",
                    "Valid": true
                },
                "status": "pending"
            },
            {
                "id": "561e0ff8-0efa-4f56-a6e1-ecb4b81de65e",
                "customerID": "62fa5415-d7c0-4648-8e08-600a90bc95c9",
                "businessID": "d04319d7-b3fb-478e-ade5-76cc5176e1dd",
                "reference": "ref12459",
                "amount": 50,
                "channel": "api",
                "createdAt": "2022-06-20T21:49:56.704274Z",
                "settledAt": {
                    "Time": "0001-01-01T00:00:00Z",
                    "Valid": false
                },
                "balanceBefore": 210,
                "balanceAfter": 260,
                "depositBeforeID": "1a83bc3c-8e1d-4cb4-8e40-32cfb0f971d9",
                "batchDate": {
                    "Time": "2022-06-20T00:00:00Z",
                    "Valid": true
                },
                "status": "pending"
            }
        ],
        "total_amount": 250
    },
    "message": "successfully get deposit ",
    "error": null
}

📘BatchDate

📘
BatchDate