PayoutMethods-Get-v6: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 28: | Line 28: | ||
{{api_output_table_header}} | {{api_output_table_header}} | ||
|- | |- | ||
| <root> || Object Array || See [[PayoutMethod- | | <root> || Object Array || See [[PayoutMethod-Response|the object]]. | ||
|- | |- | ||
|} | |} | ||
Latest revision as of 17:38, 28 May 2026
Barion API: GET v6/recipients/{recipientid}/payout-methods
| GET | /v6/recipients/{recipientid}/payout-methods |
|---|
This API endpoint returns all payout methods associated with an existing recipient.
Prerequisites before use:
Authentication
Input properties
| Property name | Property type | Limitations and constraints | Description |
|---|---|---|---|
| recipientid | string |
|
ID of an existing recipient. Passed as a path parameter. |
Output properties
The response is an array of payout method objects. For the structure of each element, see the object.
| Property name | Property type | Description |
|---|---|---|
| <root> | Object Array | See the object. |
To find out which errors this endpoint can produce, visit the Calling the API – Handling the response page. Note that this endpoint uses camelCase field names in error responses.
Possible error messages
| Condition | ErrorCode | HTTP status code |
|---|---|---|
| Authentication fails | 401 | |
| Recipient not found | RecipientNotFound |
404 |
| Referenced recipient is not connected to the opened wallet | RecipientForbidden |
403 |