You can use this endpoint to retrieve required banking fields. Use the required bankCountry parameter to specify a country.

Parameters

`bankCountry` required

Accepts ISO 3166-1 alpha-2 country codes or ISO 3166-1 alpha-3 country codes.

`paymentMethod` optional

Accepted values:

BANK_TRANSFER
PAYPAL

If no paymentMethod is specified, then the response will include requirements for any payment type supported for the bankCountry. For example, only BANK_TRANSFER requirements will be returned for Canada.

Returns

Example request

curl 'https://api.impact.com/Mediapartners/<AccountSID>/WithdrawalSettings/RequiredFields?bankCountry=US' \
  -X GET \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json'

Example response

{
  "BankCountry": "US",
  "Currency": "USD",
  "PaymentMethods": {
  "PAYPAL": {
    "RequiredFields": ["PaypalEmailAddress"]
  },
  "BANK_TRANSFER": {
    "RequiredFields": [
      "BeneficiaryAccountName",
      "BankAccountType",
      "BankAccountNumber",
      "RoutingCode"
      ]
    }
  }
}

Note: Refer to the API Errors page if you encounter any errors.