Get Payout
This is used to fetch all payouts.
HTTP Method : GET
API Endpoint : {{base_url}}/api/v1/payouts?status=history&search=things&from=01/04/2023&to=20/05/2023
Sample cURL Request
curl --location 'https://sandbox-api.ovalfi-app.com/api/v1/payouts?status=history&search=things&from=01%2F04%2F2023&to=20%2F05%2F2023' \
--header 'Signature: 8042e424f924a236e9c8b4c6a76991ffeee24328d39cbb8a31d16cbca9948bf2' \
--header 'Authorization: Bearer eyJidXNpbmVzc0lEIjoiYmEwY2E1NGMtZjRkYi00NDU5LWE4MDYtOTZkYzA3NWIzZjlkIiwidXNlcklEIjoiM2E5NjhiOWYtMzU5MC00ODZhLWE1MTMtYzg2MzkzZjZmYWI4Iiwia2V5IjoiaGFsZWVtYWgifQ=='
Response Parameter
{
"status": 200,
"data": {
"items": [
{
"id": "1ad9f8a0-6741-40e4-a130-7ea274d3fa07",
"business_id": "57cba051-80cf-4b41-a6d9-06fdc5f3a5d7",
"status": "initiated",
"count": 2,
"currency": "NGN",
"total_amount": 81257,
"fee": {
"currency": "NGN",
"symbol": "₦",
"amount": 8938.27
},
"remarks": "00057",
"cancel_reason": null,
"payout_type": "",
"is_recurring": false,
"completed_at": null,
"created_at": "2024-02-01T00:20:56.299882Z",
"updated_at": "2024-02-01T00:20:56.303628Z"
},
{
"id": "3409a231-14dd-4547-a6cd-d2eb2a796de5",
"business_id": "57cba051-80cf-4b41-a6d9-06fdc5f3a5d7",
"status": "initiated",
"count": 2,
"currency": "NGN",
"total_amount": 59719,
"fee": {
"currency": "NGN",
"symbol": "₦",
"amount": 6569.09
},
"remarks": "00056",
"cancel_reason": null,
"payout_type": "",
"is_recurring": false,
"completed_at": null,
"created_at": "2024-01-31T06:58:13.59576Z",
"updated_at": "2024-01-31T06:58:13.605236Z"
},
{
"id": "b1fa265a-5be1-40d8-8e26-949a4058ce9c",
"business_id": "57cba051-80cf-4b41-a6d9-06fdc5f3a5d7",
"status": "initiated",
"count": 1,
"currency": "NGN",
"total_amount": 40426,
"fee": {
"currency": "NGN",
"symbol": "₦",
"amount": 4446.86
},
"remarks": "00055",
"cancel_reason": null,
"payout_type": "",
"is_recurring": false,
"completed_at": null,
"created_at": "2024-01-29T23:10:08.744202Z",
"updated_at": "2024-01-29T23:10:08.756835Z"
},
{
"id": "4f0f07db-bafc-4fd8-a3b2-d3c1228945e8",
"business_id": "57cba051-80cf-4b41-a6d9-06fdc5f3a5d7",
"status": "processing",
"count": 1,
"currency": "NGN",
"total_amount": 17835,
"fee": {
"currency": "NGN",
"symbol": "₦",
"amount": 1961.85
},
"remarks": "00054",
"cancel_reason": null,
"payout_type": "",
"is_recurring": false,
"completed_at": null,
"created_at": "2024-01-23T14:10:11.196171Z",
"updated_at": "2024-01-23T14:10:11.246485Z"
},
{
"id": "0aa06d95-a08a-45ef-b167-2844b52386e6",
"business_id": "57cba051-80cf-4b41-a6d9-06fdc5f3a5d7",
"status": "processing",
"count": 1,
"currency": "NGN",
"total_amount": 13079,
"fee": {
"currency": "NGN",
"symbol": "₦",
"amount": 1438.69
},
"remarks": "00053",
"cancel_reason": null,
"payout_type": "",
"is_recurring": false,
"completed_at": null,
"created_at": "2024-01-23T14:00:12.915772Z",
"updated_at": "2024-01-23T14:00:19.666995Z"
},
{
"id": "79361c85-d16f-4b13-9f5b-e4d552b9f7bd",
"business_id": "57cba051-80cf-4b41-a6d9-06fdc5f3a5d7",
"status": "completed",
"count": 1,
"currency": "NGN",
"total_amount": 26158,
"fee": {
"currency": "NGN",
"symbol": "₦",
"amount": 90
},
"remarks": "00052",
"cancel_reason": null,
"payout_type": "multiple",
"is_recurring": false,
"completed_at": "2023-11-27T11:05:24.594401+01:00",
"created_at": "2023-11-27T10:05:17.672283Z",
"updated_at": "2023-11-27T10:05:24.594401Z"
},
{
"id": "f9a84143-18f4-485f-8f3d-4ff4d6516714",
"business_id": "57cba051-80cf-4b41-a6d9-06fdc5f3a5d7",
"status": "completed",
"count": 1,
"currency": "NGN",
"total_amount": 49938,
"fee": {
"currency": "NGN",
"symbol": "₦",
"amount": 90
},
"remarks": "00051",
"cancel_reason": null,
"payout_type": "multiple",
"is_recurring": false,
"completed_at": "2023-11-24T21:05:03.705512+01:00",
"created_at": "2023-11-24T20:04:56.503011Z",
"updated_at": "2023-11-24T20:05:03.705512Z"
},
{
"id": "6aafe237-7517-458e-a941-44d96c690057",
"business_id": "57cba051-80cf-4b41-a6d9-06fdc5f3a5d7",
"status": "completed",
"count": 1,
"currency": "NGN",
"total_amount": 22591,
"fee": {
"currency": "NGN",
"symbol": "₦",
"amount": 90
},
"remarks": "00050",
"cancel_reason": null,
"payout_type": "multiple",
"is_recurring": false,
"completed_at": "2023-11-24T13:23:45.850155+01:00",
"created_at": "2023-11-24T12:23:37.415432Z",
"updated_at": "2023-11-24T12:23:45.850155Z"
},
{
"id": "ac01944a-a414-480d-80c8-1b13c055dcab",
"business_id": "57cba051-80cf-4b41-a6d9-06fdc5f3a5d7",
"status": "processing",
"count": 1,
"currency": "NGN",
"total_amount": 1200,
"fee": {
"currency": "NGN",
"symbol": "₦",
"amount": 90
},
"remarks": "NGN",
"cancel_reason": null,
"payout_type": "multiple",
"is_recurring": false,
"completed_at": null,
"created_at": "2023-11-22T23:18:26.236587Z",
"updated_at": "2023-11-22T23:18:26.273351Z"
},
{
"id": "88812362-ad97-467a-9e54-1fbc7a345e15",
"business_id": "57cba051-80cf-4b41-a6d9-06fdc5f3a5d7",
"status": "failed",
"count": 1,
"currency": "NGN",
"total_amount": 15457,
"fee": {
"currency": "NGN",
"symbol": "₦",
"amount": 90
},
"remarks": "00049",
"cancel_reason": null,
"payout_type": "multiple",
"is_recurring": false,
"completed_at": null,
"created_at": "2023-11-07T15:14:04.147255Z",
"updated_at": "2023-11-07T15:14:04.583741Z"
}
],
"page": {
"page": 1,
"size": 10,
"has_next_page": true,
"has_previous_page": false,
"total_count": 23
},
"attributes": null
},
"message": "Fetched payouts successfully!",
"error": null
}
Updated 10 months ago