Withdrawal Settings

Endpoints for retrieving and updating your bank account, PayPal, and payment scheduling settings.

Retrieve withdrawal settings

get

Returns the partner's current withdrawal settings, including bank account and payment scheduling information.

Authorizations

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

Responses

200

application/json

PaymentMethodstring · enumOptional

How impact.com sends your payouts.

Example: BANK_TRANSFERPossible values:

PaypalEmailAddressstringOptional

Email address of the PayPal account that receives payouts. Required when PaymentMethod is PAYPAL.

BankCountrystringOptional

ISO 3166-1 alpha-2 country code of the country where the bank account is held.

Example: US

BeneficiaryAccountNamestringOptional

Full name on the bank account that will receive funds.

BeneficiaryClassificationstring · enumOptional

Classification of the account holder. BUSINESS and INDIVIDUAL apply globally; CPF and CNPJ are Brazilian taxpayer types.

Possible values:

ClassificationCodestringOptional

Additional classification code required by some country/classification combinations (notably Brazil).

BeneficiaryAlternativeNamestringOptional

Alternative name on the account, where the bank's system requires one.

BeneficiaryTaxPayerIdstringOptional

Taxpayer identifier of the beneficiary, in the format used by BankCountry (e.g., SSN/EIN for US, CPF/CNPJ for Brazil).

BankAccountTypestring · enumOptional

Type of bank account that will receive funds.

Example: NOT_SETPossible values:

BankAccountNumberstringOptional

The bank account number that will receive funds. For SEPA countries this is the IBAN.

SwiftCodestringOptional

SWIFT/BIC code identifying the receiving bank. Required for international transfers.

RoutingCodestringOptional

Domestic routing code for the receiving bank (e.g., US ABA routing number, UK sort code).

VoCodestringOptional

Country-specific verification code used by some banking jurisdictions.

AgencyCodestringOptional

Bank agency identifier used in some Latin American banking systems.

BankAddressstringOptional

Street address of the receiving bank branch.

BankPostalCodestringOptional

Postal code of the receiving bank branch.

BankCitystringOptional

City of the receiving bank branch.

BankStatestringOptional

State or province of the receiving bank branch.

BranchCodestringOptional

Branch identifier code (e.g., transit number, sort code segment, branch number).

BankNamestringOptional

Name of the receiving bank.

BranchNamestringOptional

Name of the receiving bank's branch.

PaymentSchedulingTypestring · enumOptional

Determines whether payouts trigger by balance threshold or on a fixed day of the month.

Example: BALANCE_THRESHOLDPossible values:

PaymentThresholdstringOptional

Minimum account balance that triggers a payout when PaymentSchedulingType is BALANCE_THRESHOLD. Min $20 USD, max $10,000 USD.

Example: 10000.00

PaymentDaystringOptional

Day of the month payouts are issued when PaymentSchedulingType is FIXED_DAY. Either 1 or 15. Returns 0 when not applicable.

Example: 0

UristringOptional

API resource path for these withdrawal settings.

Example: /Mediapartners/<AccountSID>/WithdrawalSettings

404

No withdrawal settings are configured for this partner account.

get/Mediapartners/{AccountSID}/WithdrawalSettings

curl

curl -L \
  --url 'https://api.impact.com/Mediapartners/{AccountSID}/WithdrawalSettings' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: application/json'

{
  "PaymentMethod": "BANK_TRANSFER",
  "PaypalEmailAddress": "",
  "BankCountry": "US",
  "BeneficiaryAccountName": "",
  "BeneficiaryClassification": "",
  "ClassificationCode": "",
  "BeneficiaryAlternativeName": "",
  "BeneficiaryTaxPayerId": "",
  "BankAccountType": "NOT_SET",
  "BankAccountNumber": "",
  "SwiftCode": "",
  "RoutingCode": "",
  "VoCode": "",
  "AgencyCode": "",
  "BankAddress": "",
  "BankPostalCode": "",
  "BankCity": "",
  "BankState": "",
  "BranchCode": "",
  "BankName": "",
  "BranchName": "",
  "PaymentSchedulingType": "BALANCE_THRESHOLD",
  "PaymentThreshold": "10000.00",
  "PaymentDay": "0",
  "Uri": "/Mediapartners/<AccountSID>/WithdrawalSettings"
}

Update withdrawal settings

put

Updates the partner's withdrawal settings. Only the parameters provided in the request body are changed; all others remain unchanged. Call RequiredFields first to learn which fields are mandatory for your country and payment method.

Authorizations

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

Body

Fields you can submit to update withdrawal settings. Any field omitted from the request is left unchanged.

PaymentMethodstring · enumOptional

How impact.com sends your payouts. Required when changing payout method.

Example: BANK_TRANSFERPossible values:

PaypalEmailAddressstringOptional

Email address of the PayPal account that receives payouts. Required when PaymentMethod is PAYPAL.

Example: hazel.nutt@example.com

BeneficiaryAccountNamestringOptional

Full name on the bank account that will receive funds.

Example: Hazel Nutt

BankCountrystringOptional

ISO 3166-1 alpha-2 country code where the bank account is held.

Example: US

BeneficiaryClassificationstring · enumOptional

Classification of the account holder. BUSINESS and INDIVIDUAL apply globally; CPF and CNPJ are Brazilian taxpayer types.

Example: INDIVIDUALPossible values:

ClassificationCodestringOptional

Additional classification code required by some country/classification combinations (notably Brazil).

BeneficiaryAlternativeNamestringOptional

Alternative name on the account, where the bank's system requires one.

BeneficiaryTaxPayerIdstringOptional

Taxpayer identifier of the beneficiary, in the format used by BankCountry (e.g., SSN/EIN for US, CPF/CNPJ for Brazil).

Example: 123-45-6789

BankAccountTypestring · enumOptional

Type of bank account that will receive funds.

Example: CHECKINGPossible values:

BankAccountNumberstringOptional

The bank account number that will receive funds. For SEPA countries this is the IBAN.

Example: 000123456789

SwiftCodestringOptional

SWIFT/BIC code identifying the receiving bank. Required for international transfers.

Example: CHASUS33

RoutingCodestringOptional

Domestic routing code for the receiving bank (e.g., US ABA routing number, UK sort code).

Example: 021000021

VoCodestringOptional

Country-specific verification code used by some banking jurisdictions.

AgencyCodestringOptional

Bank agency identifier used in some Latin American banking systems.

BankAddressstringOptional

Street address of the receiving bank branch.

Example: 270 Park Avenue

BankPostalCodestringOptional

Postal code of the receiving bank branch.

Example: 10017

BankCitystringOptional

City of the receiving bank branch.

Example: New York

BankStatestringOptional

State or province of the receiving bank branch.

Example: NY

BranchCodestringOptional

Branch identifier code (e.g., transit number, sort code segment, branch number).

Example: 12345

BankNamestringOptional

Name of the receiving bank.

Example: JPMorgan Chase Bank

BranchNamestringOptional

Name of the receiving bank's branch.

Example: Park Avenue Branch

PaymentSchedulingTypestring · enumOptional

Determines whether payouts trigger by balance threshold or on a fixed day of the month.

Example: BALANCE_THRESHOLDPossible values:

PaymentThresholdstringOptional

Minimum balance that triggers a payout when PaymentSchedulingType is BALANCE_THRESHOLD. Min $20 USD, max $10,000 USD.

Example: 50.00

PaymentDaystringOptional

Day of month payouts are issued when PaymentSchedulingType is FIXED_DAY. Either 1 or 15.

Example: 15

Responses

200

application/json

StatusstringOptional

Outcome status of the update.

Example: OK

UristringOptional

API resource path for the updated withdrawal settings.

Example: /Mediapartners/<AccountSID>/WithdrawalSettings

put/Mediapartners/{AccountSID}/WithdrawalSettings

curl

curl -L \
  --request PUT \
  --url 'https://api.impact.com/Mediapartners/{AccountSID}/WithdrawalSettings' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'Accept: application/json'

200

{
  "Status": "OK",
  "Uri": "/Mediapartners/<AccountSID>/WithdrawalSettings"
}

Retrieve required banking fields

get

Returns which fields are mandatory when configuring withdrawal settings for a given country and (optionally) payment method. Always call this before updating settings for a country you haven't configured before.

Authorizations

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

Query parameters

bankCountrystringRequired

ISO 3166-1 alpha-2 or alpha-3 country code where the bank account is held.

Example: US

paymentMethodstring · enumOptional

Filter the response to a single payment method. If omitted, requirements for all supported methods are returned.

Possible values:

Responses

200

application/json

BankCountrystringOptional

Country the requirements apply to.

Example: US

CurrencystringOptional

Three-letter ISO 4217 currency code paid out for accounts in this country.

Example: USD

get/Mediapartners/{AccountSID}/WithdrawalSettings/RequiredFields

curl

curl -L \
  --url 'https://api.impact.com/Mediapartners/{AccountSID}/WithdrawalSettings/RequiredFields?bankCountry=US' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: application/json'

200

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

PreviousWithdrawal Settings NextModels

Last updated 8 hours ago