Effiliation API

Transactions

Description

Get the publisher transactions (Sales, Leads ...)

URL(s)

https://apiv2.effiliation.com/apiv2/transaction.xml?key=YOUR_API_KEY
https://apiv2.effiliation.com/apiv2/transaction.csv?key=YOUR_API_KEY
https://apiv2.effiliation.com/apiv2/transaction.json?key=YOUR_API_KEY

Parameters

Parameter	Format	Description	Example value
key	String	Publisher api key	YOUR_API_KEY
start	Date: dd/MM/yyyy	Start period of the reporting	01/01/2013
end	Date: dd/MM/yyyy	End period of the reporting	31/01/2013
type	String	Allows to select on what type of date (start and end) the request is based. Date, date of transaction or date of validation.	date(default) / datetran (date of transaction) / datevalidation (date of validation)
effi_id	String	Your subId (an alphanumerical value)	0230
id_affilieur	Integer	Allows to only get transactions of a given merchant. id_affilieur = merchant id.	101245454
fields	String	Fields displayed in the output(0: not displayed, 1: displayed)	01100110
all	String	All transactions with or without commissions	yes

Returned fields

Use fields selector to choose the fields you need. Eg: fields=00101.

Field	Description	Type
id_transaction	Id of the transaction	String
id_affilieur	Id of the merchant	Integer
id_programme	Id of the program	Integer
id_session	Id of the session	Integer
effi_id	Your sub Id	String
effi_id2	Your second sub Id	String
type	Type of transaction (Sale, Lead...)	String
montant	Amount of the transaction (for a sale)	Decimal
commission	Commission	Decimal
etat	Status of the transaction, possible values by language : French : Attente, Valide, Refus English : Pending, Valid, Refusal German : Wartezustand, Gültig, Ablehnung Spanish : Espera, Autorizado, Rechazado Italian : Attesa, Valido, Rifiuto Portugese : Pendente, Válido, Rejeição	String
date	Date - billing view	Date
dateclic	Date of clic	Date
datetran	Date of transaction	Date
datevalidation	Date of validation	Date
en_session	For post-clic programs, indicates if the transaction is made less than 30 minutes after the clic	String
ref	Reference of the transaction	String
ref2	Second reference of the transaction	String
ref3	Third reference of the transaction	String
ref4	Fourth reference of the transaction	String
ref5	Fifth reference of the transaction	String
ip	IP address of the internet user	String
payed	Indicates if the transaction's commission has been payed by the merchant.If transaction is refused payed is always false	String
nom_programme	Name of the program	String
referer	Referer	String
nom_support	Name of the link	String
id_typelien	Type of link	Integer
appareil	Device	String
type_appareil	Device type	String
el	First commission element	String
el2	Second commission element	String
el3	Third commission element	String
el4	Fourth commission element	String
el5	Fifth commission element	String
el6	Additional commission element	String
el7	Additional commission element	String
el8	Additional commission element	String
el9	Additional commission element	String
el10	Additional commission element	String
el11	Additional commission element	String
el12	Additional commission element	String
el13	Additional commission element	String
el14	Additional commission element	String
el15	Additional commission element	String
el16	Additional commission element	String
el17	Additional commission element	String
el18	Additional commission element	String
el19	Additional commission element	String
el20	Additional commission element	String
ref6	Additional reference for the transaction	String
ref7	Additional reference for the transaction	String
ref8	Additional reference for the transaction	String
ref9	Additional reference for the transaction	String
ref10	Additional reference for the transaction	String
ref11	Additional reference for the transaction	String
ref12	Additional reference for the transaction	String
ref13	Additional reference for the transaction	String
ref14	Additional reference for the transaction	String
ref15	Additional reference for the transaction	String
ref16	Additional reference for the transaction	String
ref17	Additional reference for the transaction	String
ref18	Additional reference for the transaction	String
ref19	Additional reference for the transaction	String
ref20	Additional reference for the transaction	String
newcustomer	New customer 0/1	String
payment	Payment type	String
voucher	Voucher use for the transaction	String
attrib	Attribution	String
commission_program	Program commissions	Decimal
commission_mea	Commissions increase	Decimal
aaf_payment_date	Payment date of the invoice of the transaction	Date
aaf_code	Invoice code of the transaction	String
aaf_paid	Indicates if the transaction's invoice has been paid	Boolean

Examples

Get all transactions of january 2013 with effi_id equals to '1234'. XML format

https://apiv2.effiliation.com/apiv2/transaction.xml?key=YOUR_API_KEY&start=01/01/2013&end=31/01/2013&type=date&effi_id=1234

Get all transactions of the first of january 2013 for the merchant '00001545' based on transaction date. JSON format

https://apiv2.effiliation.com/apiv2/transaction.json?key=YOUR_API_KEY&start=01/01/2013&end=01/01/2013&type=datetran&id_affilieur=00001545