Business Platforms and marketplacesPlatforms Enterprise

Business Platforms and marketplaces Enterprise

Sections

Business Platforms and marketplaces Enterprise

Help

FAQs Account help Technical support API Status

APIs & SDKs

JavaScript SDK React SDK REST API Server SDKs Codes Webhook events iOS Android

Payout Attributes

Payout specific attributes.

marketplacebooleanOptional

If `true`, specifies that the merchant or platform is offering goods or services on behalf of 3rd party sellers.

kyc_requiredbooleanOptional

If `true`, specifies that the Kyc is required for the merchant.

country_transfer_method_currency_selectionobject<country_transfer_method_currency_selection>[]Optional

Requested country, transfer method and currency.

Items1 <= length <= 50

country_transfer_method_currency_selection properties

2 properties

countrystring<country_code>Optional

Country.

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

transfer_methodsobject<transfer_method>[]Optional

Requested transfer method and currency for a country.

Items1 <= length <= 50

transfer_method properties

2 properties

transfer_method_typeenumOptional

Transfer Method type.

Match^[0-9A-Z_-]+$Length1 <= length <= 50

Allowed values

"BANK_ACCOUNT"
"PAYPAL"
"VENMO"
"WIRE_ACCOUNT"

currenciesarray<currency_code-2>Optional

Requested Currencies for a Transfer Method.

Items1 <= length <= 50

Back to top

Payout Attributes

Payout specific attributes.

marketplacebooleanOptional

If `true`, specifies that the merchant or platform is offering goods or services on behalf of 3rd party sellers.

kyc_requiredbooleanOptional

If `true`, specifies that the Kyc is required for the merchant.

country_transfer_method_currency_selectionobject<country_transfer_method_currency_selection>[]Optional

Requested country, transfer method and currency.

Items1 <= length <= 50

country_transfer_method_currency_selection properties

2 properties

countrystring<country_code>Optional

Country.

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

transfer_methodsobject<transfer_method>[]Optional

Requested transfer method and currency for a country.

Items1 <= length <= 50

transfer_method properties

2 properties

transfer_method_typeenumOptional

Transfer Method type.

Match^[0-9A-Z_-]+$Length1 <= length <= 50

Allowed values

"BANK_ACCOUNT"
"PAYPAL"
"VENMO"
"WIRE_ACCOUNT"

currenciesarray<currency_code-2>Optional

Requested Currencies for a Transfer Method.

Items1 <= length <= 50

Payout Attributes

country_transfer_method_currency_selection properties

transfer_method properties

Back to top

On this page

On this page

Payout Attributes

country_transfer_method_currency_selection properties

transfer_method properties

Back to top

On this page

Payout Attributes

country_transfer_method_currency_selection properties

transfer_method properties

Back to top

On this page

On this page

We currently use cookies to improve and customize your experience on our site. If you accept, we’ll also use marketing cookies to show you personalized ads. Manage your cookies and learn more.

Payout Attributes

country_transfer_method_currency_selection properties

transfer_method properties

Back to top

On this page