get https://secure.vend-o.com/api/reconciliation
The reconciliation API report is a list of your end-users transactions for a given period of time.
The report can be generated in CSV or XML format. You can specify which transactions you would like to receive, based on one of the following criteria:
- Start Date
- End Date
- One or more sites IDs
- Transaction Id
UNDERSTANDING AND PREPARING THE RECONCILIATION API
Whenever you need to generate a reconciliation report, you can make a POST or GET request to our Reconciliation API. Typically you would prepare a script that would request the report on a regular basis. If you need help with the script, contact our Client Services department.
Your script prepares the request which is posted to our URL. The response will be a CSV file (MIME type text/csv) or an XML file (MIME type text/xml). You can then store or parse this data according to your needs.
PROCEDURE
- Select the set of transactions you want to receive.
- Start date and end date: A maximum difference of one month is allowed between the two dates. The maximum end date is the current date. If no end date is specified, data will be returned for only the start date.
- Site ID: You can specify several sites ID.
- Format: Choose the format you want the data.
- transactionId: Vendo transaction Id. This will return only the report for one transaction at a time. If the given transaction was not successful, the reconciliation API will not return any data. Returned field transactionCount will be 0.
TABLE 61. RESPONSE FIELDS AND ATTRIBUTES.
Column | Type (Length) | Description |
---|---|---|
header | ||
siteIDs | integer | Site identifier |
startDate | date | Start date |
endDate | date | End date |
transactionCount | integer | Total number of reported transactions for the request. |
transaction | ||
transactionID | integer | |
dateTime | date time | Date and time of the transaction.Timezone: GMT Format: YYYY-MM-DD HH:MI:SS |
type | integer | Transaction type: See, transaction types. |
isNegative | integer | Defines whether money will be debited or credited to the content provider. (0 = no; 1 = yes) |
isTest | integer | Defines if the transaction was a test-transaction. Test-transactions will not be credited to the content provider. 0 = no 1 = yes |
siteID | integer | Vendo's site ID. |
paymentMethodID | integer | Defines the payment method that was used with this transaction. |
bin | integer | First 6 digits of a credit card. |
lastFour | integer | Four last digits of a credit card. |
expiryMonth | char (2) | Two digits number representing the expiration month of a credit card. Using a leading zero when needed e.g. '09'. |
expiryYear | integer | Four digits number representing the expiration year of a credit card. |
merchantReference | varchar (1024) | Custom data passed through a join link. |
sellerAffiliateCode | varchar | Unique seller affiliate code for crossales. |
originalTransactionID | integer | Vendo's unique transaction ID of an original transaction associated with a refund or chargeback. |
programID | varchar | Program ID |
campaignID | varchar | Campaign ID |
affiliateID | varchar | Affiliate ID |
reafundReason | varchar | Reason message for transactions of type refund |
chargebackReason | varchar | Reason message for transactions of type chargeback |
invoice | ||
amount | float unsigned | Amount the end user paid. |
currency | varchar (3) | Currency of the end user's payment. |
reporting | ||
amount | float unsigned | Invoice amount converted to your preferred reporting currency. |
amountGross | float unsigned | Reporting gross amount. |
currency | varchar (3) | Your preferred reporting currency (Default USD). |
taxRate | float (3) | Tax rate |
displayed | ||
amount | float unsigned | Amount displayed to the end-user. |
currency | varchar (3) | Currency shown to the end-user. |
offer | ||
offerID | integer | Offer ID |
TypeID | integer | Vendo Offer Type ID. |
pricePointTypeID | integer | Price Point type ID |
pricePointIdentifier | varchar | Price point ID |
pricePointDuration | integer | Price Point Duration |
pricePointDurationUnit | varchar | Price Point Duration Unit |
pricePointAmount | float | Price Point Amount. |
customer | ||
customerID | integer | Customer ID |
varchar | End user's email address. | |
firstname | varchar | End user's first name. |
lastname | varchar | End user's last name. |
street | varchar | End user's street address. |
zip | varchar | End user's postal code. |
city | varchar | End user's city. |
country | char(2) | End user's country. 2-letter ISO codes. |
language | char (2) | End user's language. 2-letter ISO codes. |
ip | varchar(39) | Customer's IP address |
subscription | ||
subscriptionID | integer | Subscription ID |
username | varchar | End user's username. |
password | varchar | End user's password. |
Error codes:
Error | Code | Description |
---|---|---|
MANDATORY_PARAMETERS_MISSING | 0 | Mandatory parameters missing. |
MERCHANTID_IS_INVALID | 5 | Merchant-ID is invalid. |
AUTHTOKEN_IS_INVALID | 6 | AuthToken is incorrect. |
ACCESS_DENIED | 9 | No permission to access API. Please contact Vendo: [email protected] |
DATE_IS_INVALID | 1001 | Date-Format incorrect. Use YYYY-MM-DD |
DATE_OUT_OF_RANGE | 1002 | Date out of range. |
INVALID_MONTH | 1003 | Invalid month in date. |
INVALID_DAY | 1004 | Invalid day in date. |
ENDDATE_SMALLER_THAN_STARTDATE | 1005 | Startdate has to be smaller than enddate. |
QUERY_EXCEEDS_TIMEFRAME | 1006 | Query exceeds max reporting timeframe. |
REPORTS_AVAILABLE_UNTIL_TODAY | 1007 | Reports are only available up to "today's date". |
INVALID_SITEIDS | 2001 | SiteIds contain non integer values. |
ANAUTHORIZED_SITEIDS | 2002 | SiteIds contain unauthorized IDs. |
UNAUTHORIZED_TRANSACTIONID | 2003 | TransactionId unauthorized. |
UNKNOWN_ERROR | 9999 | Unknown error occurred. |