API Reference

Update withdrawal settings

Updates the partner's withdrawal settings by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

For example, if you pass the BankAccountNumber parameter, that parameter will become the company's new bank account number, leaving all other parameters unchanged.

Parameters

PaymentMethod optional

These are the possible ways in which a Brand can pay you.

Possible enum values
PAYPAL Get paid via Paypal. The PaypalEmailAddress field will be required if you use this PaymentMethod.
BANK_TRANSFER Get paid via Electronic Funds Transfer (EFT). In order to get paid via EFT, you will be required to provide bank account information.

PaypalEmailAddress optional

The email address of your Paypal account. The PaymentMethod must be set to PAYPAL in order to update this field.

BeneficiaryAccountName optional

The account name of the bank account related to your EFT withdrawal settings. Note that if you have a CNY (Chinese Yuan) currency account, the Beneficiary Account Name must only use English (Latin) characters (A-Z, a-z).

BankCountry optional

Two-letter ISO 3166-1 alpha-2 country code of the country in which the partner's bank operates.

BeneficiaryClassification optional

These are the possible ways in which a Brand can pay you.

Possible enum values
BUSINESS Business bank account.
INDIVIDUAL Personal bank account.
CPF Tax identification code for Brazil.
CNPJ Tax identification code for Brazil.

BeneficiaryAlternativeName optional

The alternative account name of the bank account related to your EFT withdrawal settings.

BeneficiaryTaxPayerId optional

Tax identification number for the beneficiary.

BankAccountType optional

These are the possible ways in which a Brand can pay you.

Possible enum values
CHECKING Checking bank account.
SAVINGS Savings bank account.
NOT_SET No bank account type specified.

BankAccountNumber optional

Bank account number to which EFT payments should be made.

SwiftCode optional

A code used to identify the country, bank, and branch that an account is registered to. Use this if your account is located outside of the United States.

RoutingCode optional

A 9-digit code that identifies where your bank account was opened.

VoCode optional

A 5-digit code used by Russian banks to enable payments.

AgencyCode optional

For banks that specify the need for an agency code to receive payments.

BankAddress optional

Address of the bank branch where your account was opened.

BankPostalCode optional

The postal code of the address of the bank branch where your account was opened.

BankCity optional

The city of the address of the bank branch where your account was opened.

BankState optional

The state or province of the address of the bank branch where your account was opened.

BranchCode optional

Unique identifier of the branch for your bank account.

BankName optional

The name of a financial institution associated with your bank account.

PaymentSchedulingType optional

The setting that decides when you will be paid.

Possible enum values
BALANCE_THRESHOLD This option allows you to withdraw the balance from your impact.com account after it reaches a selected amount. Min: $20USD, Max: $10 000USD
FIXED_DAY This option allows you to withdraw funds from your impact.com account on either the 1st or 15th of a given month. Min withdrawal balance $10USD.

PaymentThreshold optional

The amount to which you would like to set your balance threshold payment scheduling setting. Min: $20USD, Max: $10 000USD.

PaymentDay optional

If you've set your payment scheduling setting to a fixed day, you can select either the 1st or the 15th of the month for impact.com to payout.

Example request

curl 'https://api.impact.com/Mediapartners/<AccountSID>/WithdrawalSettings' \
  -X PUT \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'PaymentMethod=PAYPAL' \
  -d '[email protected]' \
  -d 'PaymentSchedulingType=BALANCE_THRESHOLD' \
  -d 'PaymentThreshold=50.00'

Example response

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