Retrieve Required Payout Fields
POST/payouts/fields
This endpoint retrieves data fields required to fill the recipient / sender object for a payout. You can get a list of required parameters for your store from Retrieve Payout Methods. Upon calling this endpoint, you will receive a recipient / sender object with fields that need to be filled out and submitted in the payout creation endpoint."
Request​
Responses​
- 200
- 400
- 401
- 403
- 404
- 412
- 500
- 502
- 503
A list of required fields for the specified payout method. The response format for the recipient and sender objects is the same. The recipient object is always included in the response, while the sender object is included only for those payouts where it is necessary.
Invalid request parameters.
Authentication failed. Verify that a valid Api-Access-Token is provided in the request headers.
Access denied. The API token does not have permission to retrieve payout fields for the specified shop.
Resource not found.
Precondition failed.
Internal server error. An unexpected error occurred on the server side.
Service unavailable. The upstream service is temporarily unreachable.
Service unavailable. The server is temporarily unable to handle the request.