Categories

Returns an array of Publish Point category objects that define the general topic of an affiliate's Publish Point. The selected category ID is required as the PublishPointCategory in the New Affiliate call.

The endpoint applies to the organisation identified by the {OrganisationID} parameter.

A successful call returns an array of Category items:

{
  "ID": 4,
  "Name": "Sports - Soccer"
}

Subscriptions

Returns an array of SubscriptionDetails objects representing the organisations available to the current user.

A successful call returns an array of SubscriptionDetails objects:

{
  "subscriptionID": "d937648e-6fd7-45b3-a38d-be5fe4f88ec",
  "SubscriptionName": "Subscription 1"
}

Brands

Returns an array of Brand objects representing the brands supported by the organisation.

A successful call returns an array of Brand items:

{
  "ID": 2,
  "Name": "LlamaCasino"
}

Reward Plans

Returns a list of Reward Plans that are visible and available during registration. The registrant can select a Reward Plan, which is passed in the main SignUp call as the CommissionPlanID property.

A successful call returns a list of Reward Plans.

{
  "ID": 75,
  "Name": "Rev Share 25%"
}

Payment Methods

Returns a list of available payment methods. The selected payment method is passed in the main SignUp call as the PaymentMethodID property.

Each payment method may include additional required fields. These are passed in the main SignUp call as the PaymentMethodDetails object.

A successful call returns an array of Payment Method items:

{
  "ID": 7,
  "Name": "Bank Wire Transfer",
  "Code": "dd",
  "Fields": [
    {
      "ID": 1,
      "Name": "Bank Name",
      "Required": true
    },
    {
      "ID": 2,
      "Name": "Other Bank Name",
      "Required": false
    }
  ]
}

Worked Example - Using the Payment Method Details

IDs and field requirements may differ depending on your system.

In this example, the registrant selects “Skrill (Money Bookers)” as their payment method. The payment method has an ID of 6 and requires the following field:

The required field is completed by the registrant and included in the SignUp API call using the following structure:

{
  ...
  "PaymentMethodID": 6, //This is the ID of the chosen Payment Method
  "PaymentMethodDetails": [
    {
      "ID": 10,
      "Value": "test.affiliate@example.com" //This is the value of the field that the registrant filled in
    }
    //If we had any more fields, we would insert them here
  ]
}

New Affiliate

The New Affiliate endpoint registers a new affiliate. Depending on the system configuration, it may also send confirmation or welcome emails.

The POST method accepts the affiliate details in JSON format within the request body. Some fields require IDs retrieved from the other endpoints described above.

Payment Method Detail Object Fields

{
  "SecurityAnswer": "daisy",
  "SecurityQuestionID": 10,
  "Address1": "NetRefer",
  "Address2": "High Street",
  "BrandID": 5,
  "City": "Valletta",
  "CommissionPlanID": 2,
  "Country": "MLT",
  "Currency": "EUR",
  "Email": "llamaffiliates@example.com",
  "Fax": "string",
  "FaxDialCode": "string",
  "FirstName": "David",
  "HasAdminFees": false,
  "IDNumber": "42601F",
  "Messenger": "tr.dis@example.com",
  "Name": "llamAffiliates",
  "ReceivePromotions": true,
  "Skype": "tr.dis@example.com",
  "State": "Malta",
  "Surname": "Tenant",
  "Telephone": "123456789",
  "TelephoneDialCode": "GBP",
  "Title": "HRH",
  "Zip": "ADD123",
  "PublishPointLanguage": "en",
  "PublishPointName": "Camelid Racing Secrets",
  "PublishPointCategory": 5,
  "PublishPointType": 1,
  "URL": "www.example.com/sports",
  "UserLanguage": "en",
  "Password": "secretPassword1123!",
  "Position": "string",
  "UserName": "laff",
  "UserTypeID": 1,
  "PaymentMethodID": 10,
  "PayeeName": "D. Tennant",
  "PaymentMethodDetails": [
    {
      "ID": 57,
      "Value": "test.affiliate@example.com"
    }
  ],
  "TaxRegistrationNumber": "C12345618232",
  "CompanyRegistrationNumber": "C123456",
  "RegisteredForTax": true,
  "TaxCountry": "GBR",
  "TosDocumentGuid": "b1296ad7-a57b-41a8-9f35-1098bf7477c4",
  "AcceptTos": true
}

Terms of Service

The Terms of Service endpoint returns the Terms of Service that the registrant must accept. The BrandID and LanguageCode must be supplied to retrieve the applicable Terms of Service.

If Terms of Service are not available for the specified language, the default Terms of Service are returned

If Terms of Service have not been configured, the endpoint returns a 404 Not Found response.

When the registrant accepts the Terms of Service, the Terms of Service identifier must be included in the New Affiliate call as TosDocumentGuid.

A successful call returns the Terms of Service to display to the registrant and the identifier required for the New Affiliate call.

{
  "ToSID": "b1296ad7-a57b-41a8-9f35-1098bf7477c4",
  "Content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua [...]"
}