curl --request GET \
--url https://gateway.useyala.com/api/public/payouts/{id} \
--header 'x-api-key: <api-key>'{
"statusCode": 200,
"message": "success",
"data": {
"id": "ff412724-cd9b-4bd5-91c9-8ba7c1662e5c",
"payoutRef": "88WWRnkRWu",
"baseAmount": "1000.00",
"baseCurrency": "USD",
"amountToBeSent": "0.65",
"currencyToBeSent": "NGN",
"status": "PENDING_APPROVAL",
"businessId": "b9130e5b-8804-451b-9ecf-65660e3a36b7",
"supportingDocument": "https://sample.com/doc",
"transactionDate": null,
"method": "NIP",
"channel": null,
"transactionFees": "0.07",
"methodFees": "0.00",
"VAT": "0.00",
"meta": {
"statusChange": [
{
"updatedBy": "API ",
"email": "API",
"status": "PENDING_APPROVAL",
"date": "2025-01-16T12:57:49.996Z"
}
],
"exchangeRate": {
"from": "NGN",
"to": "USD",
"id": "a836fb63-a11b-4952-896d-7ef7e01fea14",
"sellRate": 1677.808472,
"sellSpread": 0.75,
"buyRate": 1648.54248,
"buySpread": -0.75,
"marketRate": 1661,
"code": "USD/NGN"
},
"fee": {
"amount": 0.06646100000000388,
"currency": "USD",
"feeBearer": "TENANT"
}
},
"narration": "Andromeda Galaxy",
"riskLevel": "LOW",
"source": "WEB_APP",
"createdAt": "2025-10-20T19:38:51.230Z",
"updatedAt": "2025-11-30T13:49:21.769Z",
"deletedAt": null,
"beneficiary": {
"countryCode": "NGA",
"bankCountryCode": "NGA",
"accountNumber": "8068487823",
"accountName": "Will Wonker",
"bankName": "OPay",
"accountCurrency": "NGN",
"payoutMethod": "SWIFT",
"isIndividual": true,
"address": "2, 4th Avenue, Off Prince Ademola Eletu way, Jakande, Lekki",
"city": "Lekki",
"postCode": "SG1 5LH",
"swiftNumber": "34323232",
"routingNumber": "",
"sortCode": "111111",
"phoneNumber": "",
"email": "",
"bankBranchCode": "",
"bankAddress": "",
"bankCode": "34323232",
"bicNumber": "34323232",
"riskLevel": "LOW",
"verificationStatus": "PENDING",
"id": "2b838df3-47bf-4961-a9fc-dd94c5fa9e47",
"isWatchListed": false,
"country": {
"id": "0d75ba90-1392-4442-81b6-5fc76c32d19b",
"name": "Nigeria",
"code": "NGA",
"currencyCode": "NGN",
"score": 0,
"payoutCurrencies": [
{
"code": "USD",
"name": "Dollars"
}
],
"tradingStartTime": "00:00:00",
"tradingEndTime": "23:00:00",
"timeZone": 1,
"cpi": 0,
"gdpPerCapitaInUsd": 0,
"globalRating": "B-",
"isProhibited": false,
"henleyPassportIndex": 45,
"createdAt": "2024-05-12T16:42:58.176Z",
"updatedAt": "2025-05-21T15:26:56.000Z",
"deletedAt": null
},
"bankCountry": {
"id": "0d75ba90-1392-4442-81b6-5fc76c32d19b",
"name": "Nigeria",
"code": "NGA",
"currencyCode": "NGN",
"score": 0,
"payoutCurrencies": [
{
"code": "USD",
"name": "Dollars"
}
],
"tradingStartTime": "00:00:00",
"tradingEndTime": "23:00:00",
"timeZone": 1,
"cpi": 0,
"gdpPerCapitaInUsd": 0,
"globalRating": "B-",
"isProhibited": false,
"henleyPassportIndex": 45,
"createdAt": "2024-05-12T16:42:58.176Z",
"updatedAt": "2025-05-21T15:26:56.000Z",
"deletedAt": null
}
},
"sourceWallet": {
"id": "b7e5ac80-829f-4b97-b845-1b9a70f9f4ff",
"type": "BUSINESS_WALLET",
"balance": 66323010.160000004,
"currency": "NGN",
"processor": "Yala",
"walletRef": "YALA75910",
"accountNumber": "9252038588",
"accountName": null,
"businessId": "6fd2b69f-c529-4fe4-b680-29256f860553",
"meta": null,
"isLocal": false,
"createdAt": "2024-09-19T13:36:43.246Z",
"updatedAt": "2025-11-21T03:14:24.000Z"
},
"destinationWallet": {
"id": "b7e5ac80-829f-4b97-b845-1b9a70f9f4ff",
"type": "BUSINESS_WALLET",
"balance": 66323010.160000004,
"currency": "NGN",
"processor": "Yala",
"walletRef": "YALA75910",
"accountNumber": "9252038588",
"accountName": null,
"businessId": "6fd2b69f-c529-4fe4-b680-29256f860553",
"meta": null,
"isLocal": false,
"createdAt": "2024-09-19T13:36:43.246Z",
"updatedAt": "2025-11-21T03:14:24.000Z"
}
}
}Retrieve detailed information about a specific payout.
curl --request GET \
--url https://gateway.useyala.com/api/public/payouts/{id} \
--header 'x-api-key: <api-key>'{
"statusCode": 200,
"message": "success",
"data": {
"id": "ff412724-cd9b-4bd5-91c9-8ba7c1662e5c",
"payoutRef": "88WWRnkRWu",
"baseAmount": "1000.00",
"baseCurrency": "USD",
"amountToBeSent": "0.65",
"currencyToBeSent": "NGN",
"status": "PENDING_APPROVAL",
"businessId": "b9130e5b-8804-451b-9ecf-65660e3a36b7",
"supportingDocument": "https://sample.com/doc",
"transactionDate": null,
"method": "NIP",
"channel": null,
"transactionFees": "0.07",
"methodFees": "0.00",
"VAT": "0.00",
"meta": {
"statusChange": [
{
"updatedBy": "API ",
"email": "API",
"status": "PENDING_APPROVAL",
"date": "2025-01-16T12:57:49.996Z"
}
],
"exchangeRate": {
"from": "NGN",
"to": "USD",
"id": "a836fb63-a11b-4952-896d-7ef7e01fea14",
"sellRate": 1677.808472,
"sellSpread": 0.75,
"buyRate": 1648.54248,
"buySpread": -0.75,
"marketRate": 1661,
"code": "USD/NGN"
},
"fee": {
"amount": 0.06646100000000388,
"currency": "USD",
"feeBearer": "TENANT"
}
},
"narration": "Andromeda Galaxy",
"riskLevel": "LOW",
"source": "WEB_APP",
"createdAt": "2025-10-20T19:38:51.230Z",
"updatedAt": "2025-11-30T13:49:21.769Z",
"deletedAt": null,
"beneficiary": {
"countryCode": "NGA",
"bankCountryCode": "NGA",
"accountNumber": "8068487823",
"accountName": "Will Wonker",
"bankName": "OPay",
"accountCurrency": "NGN",
"payoutMethod": "SWIFT",
"isIndividual": true,
"address": "2, 4th Avenue, Off Prince Ademola Eletu way, Jakande, Lekki",
"city": "Lekki",
"postCode": "SG1 5LH",
"swiftNumber": "34323232",
"routingNumber": "",
"sortCode": "111111",
"phoneNumber": "",
"email": "",
"bankBranchCode": "",
"bankAddress": "",
"bankCode": "34323232",
"bicNumber": "34323232",
"riskLevel": "LOW",
"verificationStatus": "PENDING",
"id": "2b838df3-47bf-4961-a9fc-dd94c5fa9e47",
"isWatchListed": false,
"country": {
"id": "0d75ba90-1392-4442-81b6-5fc76c32d19b",
"name": "Nigeria",
"code": "NGA",
"currencyCode": "NGN",
"score": 0,
"payoutCurrencies": [
{
"code": "USD",
"name": "Dollars"
}
],
"tradingStartTime": "00:00:00",
"tradingEndTime": "23:00:00",
"timeZone": 1,
"cpi": 0,
"gdpPerCapitaInUsd": 0,
"globalRating": "B-",
"isProhibited": false,
"henleyPassportIndex": 45,
"createdAt": "2024-05-12T16:42:58.176Z",
"updatedAt": "2025-05-21T15:26:56.000Z",
"deletedAt": null
},
"bankCountry": {
"id": "0d75ba90-1392-4442-81b6-5fc76c32d19b",
"name": "Nigeria",
"code": "NGA",
"currencyCode": "NGN",
"score": 0,
"payoutCurrencies": [
{
"code": "USD",
"name": "Dollars"
}
],
"tradingStartTime": "00:00:00",
"tradingEndTime": "23:00:00",
"timeZone": 1,
"cpi": 0,
"gdpPerCapitaInUsd": 0,
"globalRating": "B-",
"isProhibited": false,
"henleyPassportIndex": 45,
"createdAt": "2024-05-12T16:42:58.176Z",
"updatedAt": "2025-05-21T15:26:56.000Z",
"deletedAt": null
}
},
"sourceWallet": {
"id": "b7e5ac80-829f-4b97-b845-1b9a70f9f4ff",
"type": "BUSINESS_WALLET",
"balance": 66323010.160000004,
"currency": "NGN",
"processor": "Yala",
"walletRef": "YALA75910",
"accountNumber": "9252038588",
"accountName": null,
"businessId": "6fd2b69f-c529-4fe4-b680-29256f860553",
"meta": null,
"isLocal": false,
"createdAt": "2024-09-19T13:36:43.246Z",
"updatedAt": "2025-11-21T03:14:24.000Z"
},
"destinationWallet": {
"id": "b7e5ac80-829f-4b97-b845-1b9a70f9f4ff",
"type": "BUSINESS_WALLET",
"balance": 66323010.160000004,
"currency": "NGN",
"processor": "Yala",
"walletRef": "YALA75910",
"accountNumber": "9252038588",
"accountName": null,
"businessId": "6fd2b69f-c529-4fe4-b680-29256f860553",
"meta": null,
"isLocal": false,
"createdAt": "2024-09-19T13:36:43.246Z",
"updatedAt": "2025-11-21T03:14:24.000Z"
}
}
}| Parameter | Type | Required | Description |
|---|---|---|---|
id | string (UUID) | Yes | The unique identifier of the payout |
sourceWallet shows the wallet that was debited for this payout.destinationWallet will be populated if the payout was sent to another Yala wallet.Payout ID (UUID)
"ff412724-cd9b-4bd5-91c9-8ba7c1662e5c"
A successful response
200
"success"
Show child attributes
"ff412724-cd9b-4bd5-91c9-8ba7c1662e5c"
"88WWRnkRWu"
"1000.00"
"USD"
"0.65"
"NGN"
"PENDING_APPROVAL"
"b9130e5b-8804-451b-9ecf-65660e3a36b7"
"https://sample.com/doc"
null
"NIP"
null
"0.07"
"0.00"
"0.00"
Show child attributes
Show child attributes
"NGN"
"USD"
"a836fb63-a11b-4952-896d-7ef7e01fea14"
1677.808472
0.75
1648.54248
-0.75
1661
"USD/NGN"
"Andromeda Galaxy"
"LOW"
"WEB_APP"
"2025-10-20T19:38:51.230Z"
"2025-11-30T13:49:21.769Z"
null
Show child attributes
Country code of beneficiary
"NGA"
Country code of beneficiary's bank
"NGA"
Beneficiary's account number
"8068487823"
Beneficiary's account name
"Will Wonker"
Name of beneficiary's bank
"OPay"
Currency of beneficiary's account
"NGN"
Payment method for this beneficiary
SWIFT, NIP, HK_FPS, CHINA_WIRE, FASTER_PAYMENTS, WIRE, ACH, SEPA "SWIFT"
Whether beneficiary is an individual (true) or business (false)
true
Beneficiary's address
"2, 4th Avenue, Off Prince Ademola Eletu way, Jakande, Lekki"
Beneficiary's city
"Lekki"
Beneficiary's postal code
"SG1 5LH"
SWIFT/BIC code
"34323232"
Routing number (for US banks)
""
Sort code (for UK banks)
"111111"
Beneficiary's phone number
""
Beneficiary's email address
""
Bank branch code
""
Bank address
""
Bank code
"34323232"
BIC number
"34323232"
"LOW"
"PENDING"
"2b838df3-47bf-4961-a9fc-dd94c5fa9e47"
false
Show child attributes
"0d75ba90-1392-4442-81b6-5fc76c32d19b"
"Nigeria"
"NGA"
"NGN"
0
"00:00:00"
"23:00:00"
1
0
0
"B-"
false
45
"2024-05-12T16:42:58.176Z"
"2025-05-21T15:26:56.000Z"
null
Show child attributes
"0d75ba90-1392-4442-81b6-5fc76c32d19b"
"Nigeria"
"NGA"
"NGN"
0
"00:00:00"
"23:00:00"
1
0
0
"B-"
false
45
"2024-05-12T16:42:58.176Z"
"2025-05-21T15:26:56.000Z"
null
Show child attributes
"b7e5ac80-829f-4b97-b845-1b9a70f9f4ff"
"BUSINESS_WALLET"
66323010.160000004
"NGN"
"Yala"
"YALA75910"
"9252038588"
null
"6fd2b69f-c529-4fe4-b680-29256f860553"
null
false
"2024-09-19T13:36:43.246Z"
"2025-11-21T03:14:24.000Z"
Show child attributes
"b7e5ac80-829f-4b97-b845-1b9a70f9f4ff"
"BUSINESS_WALLET"
66323010.160000004
"NGN"
"Yala"
"YALA75910"
"9252038588"
null
"6fd2b69f-c529-4fe4-b680-29256f860553"
null
false
"2024-09-19T13:36:43.246Z"
"2025-11-21T03:14:24.000Z"