Filter Transactions by status

This filter spools business transaction records using the transaction status. Records are displayed in order of datetime added.

There are 5 transaction status(es) to take note of namely :

  • Failed
  • Completed
  • Initiated
  • Pending
  • Successful

HTTP Method : GET
API Endpoint : {{baseurl}}/api/v1/transaction?status={{status}}
Sample cURL Request

curl --location --request GET 'https://api.ovalfi-app.com//api/v1/transaction?status=initiated' \
--header 'Authorization: Bearer eyJidXNpbmVzc0lEIjoiZTY2NWJkYWUtNWE0ZC00ODNiLTk2NTQtZTk0NzViMzRjY2ViIiwidXNlcklEIjoiYTY4NjE1ZGMtMjY5MS00ZmI1LTkyZmMtNTQ1NmRlN2M3YjllIiwia2V5Ijoia3JwIn0='

Response

{
    "status": 200,
    "data": {
        "items": {
            "request_id": "6458c778-1cb9-44f2-abec-2b1869ef2065",
            "transactions": [
                {
                    "id": "ec2fbeb1-1e12-4158-b37f-7b92a947419a",
                    "name": "LALA",
                    "email": "[email protected]",
                    "businessID": "d04319d7-b3fb-478e-ade5-76cc5176e1dd",
                    "customerID": "62fa5415-d7c0-4648-8e08-600a90bc95c9",
                    "yieldOfferingID": "b68fd82a-02c8-4581-ba9c-71b5d7d0412a",
                    "type": "deposit",
                    "amount": 150,
                    "currency": "USD",
                    "reference": "refee",
                    "status": "initiated",
                    "completedAt": null,
                    "createdAt": "2022-10-03T16:06:11.506236Z",
                    "batchDate": "2022-10-03T00:00:00Z",
                    "cancelReason": null
                }
            ]
        },
        "page": {
            "page": 1,
            "size": 10,
            "hasNextPage": false,
            "hasPreviousPage": false,
            "totalCount": 1
        }
    },
    "message": "fetched transactions successfully!",
    "error": null
}