Skip to main content

Retrieve Required Payout Fields

POST 
/payouts/fields

This endpoint has replaced the [GET endpoint]/docs/merchant-api/get-app-external-v-1-payout-payoutfields-getfields) because the POST endpoint provides more data and supports more providers.

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]/docs/merchant-api/get-app-external-v-1-payout-shop-getshoppayoutmethods). 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]/docs/merchant-api/post-app-external-v-1-payout-payout-create)."

Request​

Responses​

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.