Skip to main content

Retrieve Required Payout Fields

GET 
/payouts/fields/:providerCode/:instrumentType/
deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

In the future, this endpoint will be deprecated and replaced by the POST endpoint [Retrieve Required Payout Fields]/docs/merchant-api/post-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 object for a payout. These fields vary based on the specified providerCode, instrumentType. 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 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 each object.