Our public API offers several services that let you interact with various aspects of the system.

The AffiliateService part of our API allows you to directly create and fetch data about affiliates associated with your system.

The BillingDetailService allows you to update billing information for affiliates.

The PaymentMethodsService allows you to interact with affiliate's payment methods.

To properly interact with our public API, please refer to general information in our API documentation.

Below, you'll find a description of parameters used in the requests of endpoints of services mentioned above. For proper data schema see the API documentation.

AffiliateService

Get filtered list of affiliates by specific parameters

POST /api/node/affiliates/v1

Allows you to get a list of affiliates associated with your tenantID based on requested parameters.

For detailed JSON schema see our API documentation.

Parameter	Type	Description
limit	integer	The limit used for a page of results.
offset	integer	The offset used for a page of results.
registeredFrom	date-time	Starting date-time of registrations (including).
registeredTo	date-time	End datetime of registration (including).
publicIds	string	Public identifier of affiliate, present in URL of the affiliate.
emails	string	Affiliate emails.
name	string	Full name of affiliates.
statuses	enum	The state of affiliates in the system, allowed values: `ACCOUNT_STATUS_UNSPECIFIED` – Default value, traffic won't be logged. `ACCOUNT_STATUS_DISABLED` – Disabled affiliates are unable to log in to your system and receive traffic to their statistics. `ACCOUNT_STATUS_ENABLED` – Enabled affiliates have access to the system and are able to receive statistics in your system. When the affiliate status is changed to Enabled, a welcome email is sent to them. `ACCOUNT_STATUS_PENDING` – Pending affiliates are affiliates that are waiting for your approval (or they were manually switched to this status). Pending affiliates are unable to log in to your system and receive traffic to their statistics.
tierIds	string	Identifier of affiliate tier in the system, see Affiliate tiers for more details, or the TiersService in our API.
registrationCountryCodes	string	Affiliate registration country code, ISO 3166-1 Alpha-3 code format.
sourceStatuses	enum	Designates if traffic coming from the affiliate is being recorded by the system. Allowed values: `SOURCE_STATUS_UNSPECIFIED`: Default state, unspecified traffic is not being recorded. `SOURCE_STATUS_DISABLED`: Traffic recording is disabled. `SOURCE_STATUS_ENABLED`: Traffic recording is enabled.
referralAccountIds	string	Unique affiliate identifiers.
isSuspected	boolean	Designates if affiliate is flagged by our fraud detection systems as suspicious.

Create a new affiliate

POST /api/node/affiliates/v1/register-with-user

Creates a new affiliate in the system. The affiliate is automatically paired with your tenant account.

For detailed JSON schema, see our API documentation.

Parameter	Type	Description
email	string	Email of the newly created affiliate.
password	string	Default password used for affiliate login.
name	string	Full name of the created affiliate
publicID	string	Public identifier of affiliate, present in URL of the affiliate.
status	enum	Affiliate status after creation, allowed values: `ACCOUNT_STATUS_UNSPECIFIED` – Default value. `ACCOUNT_STATUS_DISABLED` – Disabled affiliates are unable to log in to your system and receive traffic to their statistics. `ACCOUNT_STATUS_ENABLED` – Enabled affiliates have access to the system and are able to receive statistics in your system. When the affiliate status is changed to Enabled, a welcome email is sent to them. `ACCOUNT_STATUS_PENDING` – Pending affiliates are affiliates that are waiting for your approval (or they were manually switched to this status). Pending affiliates are unable to log in to your system and receive traffic to their statistics.
referralAccountId	string	Unique identifier of the affiliate in the system.

BillingDetailService

This service allows you to add billing detail to your affiliates.

Create a new billing detail

POST /api/node/billing-details/v1

Creates a new billing detail for specific user (account).

For detailed JSON schema, see our API documentation.

Parameter	Type	Description
accountId	string	ID of the account the billing details will be updated for.
name	string	Full name for the billing detail.
addressLine1	string	First line of the address.
city	string	Address city.
countryCode	string	Affiliate registration country code, ISO 3166-1 Alpha-3 code format.
postalCode	string	Address postal code.
addressLine2	string	Second line of the address.
invoicingEmail	string	Email to appear on credits notes/invoices.
vat	string	VAT.

PaymentMethodService

Manage payment methods for your affiliates. Read more here.

Create a new payment method

POST /api/node/payment-methods/v1

Creates a new payment method in the system. Once created, affiliates will be able to select the payment method as their preferred method for payout.

Parameter	Type	Description
accountId	string	ID of account for which the payment method is to be added.
type	enum	Payment method types, allowed values: `PAYMENT_METHOD_TYPE_UNSPECIFIED` – Default, unspecified value. `PAYMENT_METHOD_TYPE_BANK_TRANSFER` – Bank transfer information. `PAYMENT_METHOD_TYPE_BITCOIN` – Bitcoin transfer. `PAYMENT_METHOD_TYPE_CREDIT_STORE` – Credit store. `PAYMENT_METHOD_TYPE_DIRECT_DEPOSIT` – Direct money deposit. `PAYMENT_METHOD_TYPE_ETHER` – Ethereum transfer. `PAYMENT_METHOD_TYPE_GIFT_CARD` – Gift card payment `PAYMENT_METHOD_TYPE_MERCADO_PAGO` – Payment via Mercado Pago `PAYMENT_METHOD_TYPE_NETELLER` – Payment via Neteller `PAYMENT_METHOD_TYPE_PAYONEER` – Payment via Payoneer `PAYMENT_METHOD_TYPE_PAY_PAL` – Payment via PayPal `PAYMENT_METHOD_TYPE_SEPA` – SEPA Payment `PAYMENT_METHOD_TYPE_SKRILL` – Skrill Payment `PAYMENT_METHOD_TYPE_USDC` – USDC Payment `PAYMENT_METHOD_TYPE_USDT` – USDT Payment `PAYMENT_METHOD_TYPE_WISE` – Payment via Wise
code	string	The three-letter currency code defined in ISO 4217.
default	boolean	Designates if payment method should be set as default one, only one default payment method can be set.

Bank Transfer

bankAccountNumber	string	Number of the bank account.
bankAddress	string	Address of the bank.
bankName	string	Registered name of the bank.
swift	string	SWIFT of the bank account.
aba	string	ABA number (for U.S. transfers.)
note	string	Internal note.

Bitcoin

cryptoWalletAddress	string	Bitcoin wallet address.
note	string	Internal note.

Credit Store

identification	string	Credit store information.
note	string	Internal note.

Direct Deposit

accountNumber	string	Bank account number.
accountHolder	string	Name of the account holder.
bankName	string	Bank name.
bankRoutingNumber	string	ABA/bank routing number of the bank.
note	string	Internal note.

Ether

cryptoWalletAddress	string	ETH wallet address.
note	string	Internal note.

Gift Card

identification	string	Gift card code/identifier.
note	string	Internal note.

Mercado Pago

email	string	Registered email.
firstName	string	First name.
lastName	string	Last name.
note	string	Internal note.

Neteller

email	string	Registered email.
note	string	Internal note.

Payoneer

email	string	Registered email.
note	string	Internal note.

PayPal

email	string	Registered email.
note	string	Internal note.

SEPA

IBAN	string	IBAN of the bank account.
beneficiaryName	string	Bank account holder name.
bic	string	BIC/SWIFT code of the banking institution.
note	string	Internal note.

Skrill

email	string	Registered email address.
note	string	Internal note.

USDC

cryptoWalletAddress	string	USDC wallet address.
note	string	Internal note.

USDT

cryptoWalletAddress	string	USDT wallet address.
note	string	Internal note.

Wise

email	string	Registered email address.
note	string	Internal note.

Update a specific payment method

PATCH /api/node/payment-methods/v1/{id}

Updates the data for selected payment method.

Parameter	Type	Description
id	string	Payment method ID.

Rest of parameter descriptions are the same as in endpoint: POST /api/node/payment-methods/v1

Affiliate Statuses

Paying Affiliates via Wise.com

How to manually attribute a Stripe customer to an affiliate?

Affiliate view on the system

Automated payments via Tipalti