Get Payout by Id
This API is called to retrieve a list of a payout, and the corresponding payout_accounts linked with that payout.
HTTP Method : GET
API Endpoint : {{base_url}}/api/v1/payouts/{{payout-id}}
Sample cURL Request
curl --location 'https://sandbox-api.ovalfi-app.com/api/v1/payouts/66eca1aa-393f-4c51-8dc3-03c58b586585' \
--header 'Authorization: Bearer eyJidXNpbmVzc0lEIjoiYmEwY2E1NGMtZjRkYi00NDU5LWE4MDYtOTZkYzA3NWIzZjlkIiwidXNlcklEIjoiM2E5NjhiOWYtMzU5MC00ODZhLWE1MTMtYzg2MzkzZjZmYWI4Iiwia2V5IjoiaGFsZWVtYWgifQ==' \
--header 'Signature: 8042e424f924a236e9c8b4c6a76991ffeee24328d39cbb8a31d16cbca9948bf2'
Response Parameters
{
"status": 200,
"data": {
"items": {
"id": "66eca1aa-393f-4c51-8dc3-03c58b586585",
"business_id": "ba0ca54c-f4db-4459-a806-96dc075b3f9d",
"status": "pending",
"count": 5,
"currency": "NGN",
"total_amount": 95020,
"fee": {
"currency": "NGN",
"symbol": "₦",
"amount": 90
},
"remarks": "",
"cancel_reason": null,
"completed_at": null,
"created_at": "2023-06-19T12:55:53.535183Z",
"updated_at": "2023-06-19T12:55:53.620868Z"
},
"page": {
"page": 1,
"size": 10,
"has_next_page": false,
"has_previous_page": false,
"total_count": 5
},
"attributes": [
{
"id": "bbe5df7f-583c-4fc4-b074-11208fe52f03",
"business_id": "ba0ca54c-f4db-4459-a806-96dc075b3f9d",
"payout_id": "66eca1aa-393f-4c51-8dc3-03c58b586585",
"name": "AJ Ninja",
"details": {
"city": "",
"country": "",
"bank_code": "044",
"bank_name": "ACCESS BANK",
"district": "",
"swift_code": "",
"bank_branch": "",
"is_within_US": "",
"postal_code": "",
"account_name": "AJ Ninja",
"bank_address": "",
"account_number": "0104551193",
"routing_number": ""
},
"amount": {
"currency": "USD",
"symbol": "$",
"amount": 10000
},
"status": "pending",
"provider": "collect",
"lookup_info": "account lookup successful",
"remarks": "I must have money",
"completed_at": null,
"created_at": "2023-06-19T12:55:53.530946Z",
"updated_at": "2023-06-19T12:55:53.618045Z"
},
{
"id": "4109a64a-3273-4afb-82df-3d8e8126763d",
"business_id": "ba0ca54c-f4db-4459-a806-96dc075b3f9d",
"payout_id": "66eca1aa-393f-4c51-8dc3-03c58b586585",
"name": "Kenny Ninja",
"details": {
"city": "",
"country": "",
"bank_code": "044",
"bank_name": "ACCESS BANK",
"district": "",
"swift_code": "",
"bank_branch": "",
"is_within_US": "",
"postal_code": "",
"account_name": "Kenny Ninja",
"bank_address": "",
"account_number": "0065766427",
"routing_number": ""
},
"amount": {
"currency": "USD",
"symbol": "$",
"amount": 5000
},
"status": "pending",
"provider": "collect",
"lookup_info": "account lookup successful",
"remarks": "CHOP LIFE",
"completed_at": null,
"created_at": "2023-06-19T12:55:53.530944Z",
"updated_at": "2023-06-19T12:55:53.612625Z"
},
{
"id": "edf8a697-a570-438a-b788-07e13d6e7a36",
"business_id": "ba0ca54c-f4db-4459-a806-96dc075b3f9d",
"payout_id": "66eca1aa-393f-4c51-8dc3-03c58b586585",
"name": "kehinde Ninja",
"details": {
"city": "",
"country": "",
"bank_code": "221",
"bank_name": "STANBIC IBTC BANK",
"district": "",
"swift_code": "",
"bank_branch": "",
"is_within_US": "",
"postal_code": "",
"account_name": "Kehinde Ninja",
"bank_address": "",
"account_number": "0014075961",
"routing_number": ""
},
"amount": {
"currency": "USD",
"symbol": "$",
"amount": 50000
},
"status": "pending",
"provider": "collect",
"lookup_info": "account lookup successful",
"remarks": "SALARY",
"completed_at": null,
"created_at": "2023-06-19T12:55:53.530941Z",
"updated_at": "2023-06-19T12:55:53.605884Z"
},
{
"id": "86408d74-bde8-4b59-8836-6c57efb792c5",
"business_id": "ba0ca54c-f4db-4459-a806-96dc075b3f9d",
"payout_id": "66eca1aa-393f-4c51-8dc3-03c58b586585",
"name": "Beans Cooker",
"details": {
"city": "",
"country": "",
"bank_code": "044",
"bank_name": "ACCESS BANK",
"district": "",
"swift_code": "",
"bank_branch": "",
"is_within_US": "",
"postal_code": "",
"account_name": "Beans cooker",
"bank_address": "",
"account_number": "0065566427",
"routing_number": ""
},
"amount": {
"currency": "USD",
"symbol": "$",
"amount": 10000
},
"status": "pending",
"provider": "collect",
"lookup_info": "account lookup successful",
"remarks": "Olowolayemo",
"completed_at": null,
"created_at": "2023-06-19T12:55:53.530939Z",
"updated_at": "2023-06-19T12:55:53.601355Z"
},
{
"id": "85d934bd-fa27-4dc2-b8fb-e0155dede3ce",
"business_id": "ba0ca54c-f4db-4459-a806-96dc075b3f9d",
"payout_id": "66eca1aa-393f-4c51-8dc3-03c58b586585",
"name": "Odetola Kehinde",
"details": {
"city": "",
"country": "",
"bank_code": "221",
"bank_name": "STANBIC IBTC BANK",
"district": "",
"swift_code": "",
"bank_branch": "",
"is_withinUS": "",
"postal_code": "",
"account_name": "Beans cooker",
"bank_address": "",
"account_number": "0014589961",
"routing_number": ""
},
"amount": {
"currency": "USD",
"symbol": "$",
"amount": 20020
},
"status": "pending",
"provider": "collect",
"lookup_info": "account lookup successful",
"remarks": "ORIYOMIFX",
"completed_at": null,
"created_at": "2023-06-19T12:55:53.530923Z",
"updated_at": "2023-06-19T12:55:53.588537Z"
}
]
},
"message": "Fetched payouts successfully!",
"error": null
}
Updated 10 months ago