In dit onderwerp wordt beschreven hoe u transactiegegevens kunt downloaden als Comma Separated Values (CSV) door een HTTPS POST query string in te dienen. Door de hier beschreven CSV-downloadfunctie te implementeren, kan uw systeem worden geconfigureerd om verzoeken namens u te verwerken, zodat u het proces van het downloaden van de vereiste records kunt automatiseren.
CSV-bestanden met transactiegegevens kunnen ook worden gedownload door in te loggen op Portal en de Transactie zoekpagina te gebruiken.
Het maximum aantal records dat kan worden gedownload is 75.000.
Als je meer dan 75.000 records hebt, raden we aan om kleinere tijdsbestekken aan te vragen en meerdere opeenvolgende verzoeken uit te voeren.
Procesoverzicht
Met deze functie kunt u details downloaden van verzoeken die op uw rekening zijn verwerkt en die aan uw opgegeven criteria voldoen. U kunt kiezen welke velden worden geretourneerd, zodat u alleen de informatie downloadt die u nodig hebt.
Voorbeelden van gebruik:
- Download informatie over alle transacties die op één dag zijn verwerkt.
- Download de namen van alle klanten die in de afgelopen maand voor meer dan €999 hebben gekocht.
- Download de transactiereferenties van opgeschorte transacties in een bepaald tijdsbestek.
Het volgende is een voorbeeld van een POST voor het opvragen van een Transactie downloaden CSV rapport:
wget --output-document=output.csv --user=example@example.com --ask-password --post-data="sitereferences=test_site12345&startdate=2017-01-01&enddate=2017-01-31&settlestatuss=100&optionalfields=errorcode&optionalfields=currencyiso3a&optionalfields=authcode&optionalfields=orderreference&optionalfields=paymenttypedescription&optionalfields=settlestatus&optionalfields=settlemainamount&optionalfields=settleduedate&optionalfields=customercountryiso2a" https://myst.securetrading.net/auto/transactions/transactionsearch
Het bovenstaande verzoek bestaat uit vier hoofdonderdelen:
Je moet een Trust Payments API gebruikersnaam opgeven met voldoende gebruikersrechten om de download uit te voeren voor de opgegeven site referentie(s).
--user=example@example.com --ask-password
Het CSV-bestand kan worden gedownload met een HTTPS POST query string met Basic Access Authentication. Basic Access Authentication is een methode voor een web browser client programma om een gebruikersnaam en wachtwoord op te geven bij het verwerken van een verzoek.
Ondersteunde gebruikersrollen
U kunt uw Webservices gebruikersnaam en wachtwoord gebruiken om transactiebestanden en rapporten te downloaden. Als je nog geen Webservices gebruikersnaam hebt, kun je een nieuwe API-gebruiker aanmaken met Portal.
U kunt ook een nieuwe gebruikersrol Extra Transactie downloaden aanmaken, die toegang heeft tot extra informatie over acquirer fees. (Informatie over acquirer fees is alleen beschikbaar voor transacties die worden verwerkt met een deelnemende acquiring bank. Neem contact op met ons ondersteuningsteam voor meer informatie)
Wij ondersteunen ook twee extra gebruikersrollen voor CSV-downloads. Dit zijn "Transactie downloaden" en "Rapport downloaden", voor het downloaden van respectievelijk transactierecords en rapporten. Voor het instellen van gebruikers met deze rollen kunt u contact opnemen met ons Support Team.
Autorisatie kop
Een gebruikersnaam en wachtwoord, gescheiden door een dubbele punt en vervolgens base64 gecodeerd, moeten worden opgenomen in de autorisatie header bij het uitvoeren van het verzoek. De meeste URL-bibliotheken zullen de basisverificatieheader automatisch aanmaken, maar als u dit handmatig moet doen, volg dan dit voorbeeld:
Gebruikersnaam: csvdownload@example.com
Wachtwoord: pa55word
Gescheiden door een dubbele punt: csvdownload@example.com:pa55word
Base64 encodeer: Y3N2ZG93bmxvYWRAZXhhbXBsZS5jb206cGE1NXdvcmQ=
Daarom moet de autorisatie header zijn:
Authorization: Basic Y3N2ZG93bmxvYWRAZXhhbXBsZS5jb206cGE1NXdvcmQ=
In het verzoek kunnen filters worden opgenomen, zodat alleen records worden teruggezonden die aan bepaalde criteria voldoen.
sitereferences=test_site12345&startdate=2017-01-01&enddate=2017-01-31&settlestatuss=100
Standaard worden alle transacties binnen het datumbereik voor de opgegeven sitereferentie(s) gedownload. Er kunnen filters worden toegepast op de download, zodat alleen bepaalde records worden geretourneerd. In het bovenstaande voorbeeld zijn de volgende filters toegepast:
- Site referentie: test_site12345
- Transactie autorisatie datum: 1 januari 2017 - 31 januari 2017
- Status betaling: 100
Meerdere waarden voor dezelfde filters kunnen in de oproep worden opgenomen, gescheiden door een "&".
Bijvoorbeeld voor het downloaden van e-commerce en MOTO transacties, de accounttypedescriptions filter kan tweemaal worden opgenomen met twee verschillende waarden:
accounttypedescriptions=ECOM&accounttypedescriptions=MOTO
Noodzakelijke filters
De volgende velden moeten in de POST-gegevens worden opgenomen:
Naam filter | Commentaar |
sitereferences | De sitereferentie/s om gegevens van te downloaden. |
startdate | De begindatum voor de gespecificeerde records (in het formaat JJJJ-MM-DD). |
enddate | De einddatum voor de gespecificeerde records (in het formaat JJJJ-MM-DD). |
Gegevens kunnen worden gedownload voor meerdere sitereferenties door extra sitereferenties velden in de oproep op te nemen, gescheiden door een "&".
Als er bijvoorbeeld transacties nodig zijn voor site1 en site2, zou de oproep het volgende inhouden:
sitereferences=site1&sitereferences=site2
Merk op dat zelfs bij het downloaden van transacties voor één site referentie het veld altijd moet worden opgeroepen sitereferences.
Optionele filters
Nuttige filters
Hieronder volgt een lijst van de meest gebruikte filters door onze handelaren:
(Neem contact op met ons Support Team om te informeren naar de beschikbaarheid van extra filters)
Naam filter | Commentaar |
accounttypedescriptions |
Filter op type rekening, bijvoorbeeld "ECOM" voor e-commerce. Je kunt de accounttypen die zijn ingeschakeld voor je account bekijken op Portal door naar de pagina met je sitegegevens te gaan en op "Accounts" te klikken. |
currencyiso3as |
Filter op Munt. |
errorcodes |
Filter op foutcodes (errorcode). |
paymenttypedescriptions | Filter op Betalingstype. bijv. "VISA", "MASTERCARD" enz. |
requesttypedescriptions |
Type verzoek, bijvoorbeeld "AUTH", "REFUND" enz. |
settlestatuss |
Filter op status. Bijvoorbeeld "100" voor alle afgewikkelde transacties. |
Merk op dat om te zoeken op settlestatus, moet het veld settlestatuss.
Filter op tijd
Gebruik de volgende filters om gegevens te downloaden over transacties binnen een bepaald tijdsbereik:
Naam filter | Commentaar |
starttimehour | Om transacties te vinden tussen HH:mm:00 en HH:mm:59 *Gevraagd indien eindtijd gespecificeerd |
starttimeminute | Om transacties te vinden tussen HH:mm:00 en HH:mm:59 * Verplicht indien starttimehour gespecificeerd |
endtimehour | Om transacties te vinden tussen HH:mm:00 en HH:mm:59 * Verplicht indien starttijd is opgegeven |
endtimeminute | Om transacties te vinden tussen HH:mm:00 en HH:mm:59 * Verplicht indien endtimehour gespecificeerd |
Bijvoorbeeld voor het downloaden van transacties tussen 13:30:00 en 14:29:59:
starttimehour=13&starttimeminute=30&endtimehour=14&endtimeminute=29
Type datum
Standaard worden gespecificeerde datums en tijden gefilterd op basis van wanneer de transactie aanvankelijk werd verwerkt. U kunt echter expliciet aangeven welk type datum/tijd wordt gefilterd door het volgende extra filter op te nemen:
Naam filter | Commentaar |
datetypes | Geef aan "settledtimestamp" om te filteren op datum/tijdstip waarop de transacties werden afgewikkeld.
Geef aan "transactionstartedtimestamp" om te filteren op datum/tijdstip waarop verzoeken werden verwerkt. |
Als uw systeem een groot volume aan transacties verwerkt, raden wij aan CSV-bestanden van transacties op uurbasis (in plaats van dagelijks) te downloaden, voor optimale prestaties en om de grootte van de gedownloade bestanden te beperken. Uw systeem kan elk uur een verzoek indienen en daarbij de tijdfilters specificeren zoals hierboven beschreven, zodat alleen transacties die in het laatste uur zijn verwerkt, worden opgenomen.
Hier kunt u aangeven welke gegevensvelden moeten worden teruggezonden.
Alle Transactie downloaden CSV's de Transactiereferentie bevatten voor elke geretourneerde record.
Voorbeelduitvoer:
transactionreference
13-2-81000
13-28-1
13-28-10
13-28-11
U kunt extra velden opgeven die moeten worden teruggegeven in de Transactie downloaden, zoals in onderstaand voorbeeld:
optionalfields=errorcode&optionalfields=currencyiso3a&optionalfields=authcode&optionalfields=orderreference&optionalfields=paymenttypedescription&optionalfields=settlestatus&optionalfields=settlemainamount&optionalfields=settleduedate&optionalfields=customercountryiso2a
Het bovenstaande voorbeeld bevat de volgende optionele velden:
- Foutcode
- Munt
- Auth code
- Referentie bestelling
- Payment Type (Betalingstype)
- Status betaling (settlestatus)
- Settle hoofdbedrag
- Deadline betaling
- Land van de klant
De uitvoer zou deze optionele velden bevatten. De in het verzoek opgegeven veldnamen staan op de eerste regel van de CSV-uitvoer, in dezelfde volgorde:
transactionreference,errorcode,currencyiso3a,authcode,orderreference,paymenttypedescription,settlestatus,settlemainamount,settleduedate,customercountryiso2a
23-9-1,0,GBP,TEST,20161,VISA,100,10.99,2017-01-03,GB
23-9-2,0,GBP,TEST,20162,MASTERCARD,100,11.98,2017-01-10,GB
23-9-3,0,GBP,TEST,20163,MASTERCARD,100,10.99,2017-01-11,GB
23-9-4,0,GBP,TEST,20164,MASTERCARD,100,10.99,2017-01-16,GB
Als een gevraagd optioneel veld geen waarde heeft, wordt een lege tekenreeks teruggestuurd in de CSV.
Volledige lijst van optionele velden
In de volgende paragrafen worden de velden opgesomd die in de uitvoer kunnen worden opgenomen, indien zij in het verzoek zijn gespecificeerd:
Transactie details
Naam van het veld | Commentaar |
requesttypedescription | Type verzoek dat is uitgevoerd (bijv. "AUTH", "REFUND"). |
transactionreference | Trust Payments uniek Transactiereferentie. |
parenttransactionreference | Transactiereferentie van de bovenliggende transactie. In het geval van terugbetalingen is dit bijvoorbeeld de verwijzing naar de terugbetaalde transactie. |
accounttypedescription |
Accounttype, bijvoorbeeld "ECOM" voor e-commerce. Je kunt de accounttypen die zijn ingeschakeld voor je account bekijken op Portal door naar de pagina met je sitegegevens te gaan en op "Accounts" te klikken. |
baseamount | Transactie in basisbedrag. Bijvoorbeeld €10 is 1000 |
mainamount | Transactie in hoofdbedrag. Bijvoorbeeld €10 wordt 10.00 |
errorcode |
Foutcode voor de transactie. |
currencyiso3a |
Munt van de transactie. |
authcode | Transactie autorisatie code. |
customerip | Klant IP. |
fraudrating | Transactie frauderating. |
orderreference | Orderreferentie van de handelaar. |
Betalingsgegevens
Naam van het veld | Commentaar |
paymenttypedescription | Type betaling, bijvoorbeeld "VISA", "MASTERCARD". |
maskedpan | Gemaskerd kaartnummer. |
expirydate | Vervaldatum van de kaart. |
afwikkeling details
Naam van het veld | Commentaar |
settlestatus |
De huidige transactiestatus. |
settlemainamount | Te vereffenen/afgewikkeld bedrag. |
settleduedate | Datum van afwikkeling/vereffening. |
Beveiligingsantwoord
Het antwoord van de AVS en beveiligingscodecontroles die zijn uitgevoerd tijdens autorisatie. Dit kan een van de volgende waarden zijn:
- 0 = DATA NOT GIVEN
- 1 = DATA NOT CHECKED
- 2 = DATA MATCH
- 4 = DATA NOT MATCHED
Naam van het veld | Commentaar |
securityresponsesecuritycode | Resultaat van de beveiligingscode controle. |
securityresponseaddress | Resultaat van adrescontrole. |
securityresponsepostcode | Resultaat van postcodecontrole. |
Factuurgegevens
Naam van het veld | Commentaar |
billingprefixname | Voorvoegsel naam. Bijvoorbeeld "De heer, Juffrouw, Dr." |
billingfirstname | Voornaam. |
billingmiddlename | Middelste naam. |
billinglastname | Achternaam. |
billingsuffixname | Naam achtervoegsel. Bijvoorbeeld "BSc, PhD". |
billingpremise | Eerste regel van het adres. |
billingstreet | Adres Straat. |
billingtown | Adres Stad. |
billingcounty | Adres Provincie. |
billingemail | E-mailadres. |
billingcountryiso2a |
Adres Land. |
billingpostcode | Adres Postcode. |
factureringtelefoons | Telefoonnummers. |
Levering
Naam van het veld | Commentaar |
customerprefixname | Voorvoegsel naam. Bijvoorbeeld "De heer, Juffrouw, Dr." |
customerfirstname | Voornaam. |
customermiddlename | Middelste naam. |
customerlastname | Achternaam. |
customersuffixname | Naam achtervoegsel. Bijvoorbeeld "BSc, PhD". |
customerpremise | Eerste regel van het adres. |
customerstreet | Adres Straat. |
customertown | Adres Stad. |
customercounty | Adres Provincie. |
customeremail | E-mailadres. |
customercountryiso2a |
Adres Land. |
customerpostcode | Adres Postcode. |
customertelephones | Telefoonnummers. |
Gegevens van de handelaar
Naam van het veld | Commentaar |
merchantname | Handelsnaam geassocieerd met sitereferentie. |
tid | De Terminal ID die wordt gebruikt om de transactie te verwerken. Dit is gekoppeld aan uw handelaarsnummer toen wij uw account in onze systemen instelden. |
Vergoedingen voor de koper
De volgende velden kunnen alleen worden teruggegeven als aan de volgende vereisten is voldaan:
- Deze velden worden alleen ingevuld wanneer transacties worden verwerkt met een ondersteunde acquirer. Neem contact op met ons Support Team voor meer informatie.
- De gebruikersrol Extra transactiedownload moet worden gebruikt om de download uit te voeren (deze velden kunnen niet worden geretourneerd met gebruikersrol Webservices).
Naam van het veld | Commentaar |
acquirerassessmentfeetotal | De door Visa en Mastercard in rekening gebrachte vergoedingen voor de regeling. |
acquirercalculatedpayment | Het berekende nettobedrag voor de gegeven periode. |
acquirercrossborderfees | Grensoverschrijdende vergoedingen van Mastercard in verband met de vergoedingen voor het kaartsysteem, als onderdeel van het IC++ prijsmodel. |
acquirermpifeetotal | De door de kaartuitgever aangerekende afwikkelingsvergoedingen. |
acquirerpricingcategory | Indicator van het type kaart (of het een consumenten-, premium- of commerciële kaart is die door de kaarthouder wordt gebruikt). |
acquirerregion | Indicator of de transactie plaatsvindt in een binnenlandse, intraregionale of interregionale omgeving. |
acquirertranfees | De door de Acquirer in rekening gebrachte transactiekosten. |
Download de CSV van de volgende URL:
https://myst.securetrading.net/auto/transactions/transactionsearch
Het gebruik van deze URL wordt niet beïnvloed door de migratie van MyST naar Portal
. Blijf aanvragen verwerken via de bovenstaande MyST URL.
Uitgang
Als uw verzoek succesvol is, heeft de CSV-uitvoer de volgende structuur:
transactionreference,errorcode,currencyiso3a,authcode,orderreference,paymenttypedescription,settlestatus,settlemainamount,settleduedate,customercountryiso2a
23-9-1,0,GBP,TEST,20161,VISA,100,10.99,2017-01-03,GB
23-9-2,0,GBP,TEST,20162,MASTERCARD,100,11.98,2017-01-10,GB
23-9-3,0,GBP,TEST,20163,MASTERCARD,100,10.99,2017-01-11,GB
23-9-4,0,GBP,TEST,20164,MASTERCARD,100,10.99,2017-01-16,GB
23-9-5,0,GBP,TEST,20165,DELTA,100,16.98,2017-01-26,GB
23-9-7,0,GBP,TEST,20166,AMEX,100,10.99,2017-01-29,GB