Dit onderwerp beschrijft hoe u rapportagegegevens kunt downloaden als Comma Separated Values (CSV) door het indienen van een HTTPS POST query string. Door de hier beschreven CSV-downloadfunctionaliteit 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.
Wij bieden ook soortgelijke functionaliteit in MyST, wat een handmatig proces is waarbij een gebruiker moet zijn aangemeld en aanwezig moet zijn om de download te starten. Klik hier voor meer informatie.
Het maximum aantal records dat kan worden gedownload is 75.000.
Als u meer dan 75.000 records hebt, raden wij aan kleinere tijdskaders aan te vragen en meerdere opeenvolgende verzoeken uit te voeren.
Procesoverzicht
Met rapporten kunt u het aantal verzoeken bijhouden dat gedurende een bepaalde periode op uw rekening is verwerkt. Deze informatie wordt gegroepeerd volgens criteria die in de POST zijn gespecificeerd.
Voorbeelden van gebruik:
- Download het aantal toegestane transacties.
- Download het aantal opgeschorte transacties.
- Download het totale verrekende bedrag.
- Download het aantal met PayPal verwerkte transacties.
Het volgende is een voorbeeld van een POST voor het opvragen van een Rapport 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&sqlgroupbys=currencyiso3a&sqlgroupbys=paymenttypedescription" https://myst.securetrading.net/auto/transactions/reporting
Het bovenstaande verzoek bestaat uit vier hoofdonderdelen:
U moet een MyST gebruikersnaam opgeven met voldoende gebruikersrechten om de download uit te voeren voor de opgegeven sitereferentie(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 transactiegegevens en rapporten te downloaden. Als u nog geen Webservices gebruikersnaam heeft, kunt u een nieuwe gebruiker aanmaken via MyST.
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 sitereferenties moet heten.
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. U kunt de op uw account ingeschakelde accounttypes bekijken in MyST, door naar uw Locatiegegevens pagina te gaan en op "Rekeningen" 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 Rapport downloaden CSV's de naam van de acquirer bevatten en het aantal transacties dat voor elk van deze acquirers binnen het gegeven tijdsbestek is afgewikkeld.
Voorbeelduitvoer:
acquirertypedescription,settledcount
BARCLAYS,1916
PAYPAL,249
PAYSAFE,18
TEST,4
Groepering
De uitvoer die in Rapport downloaden wordt geretourneerd, kan worden gegroepeerd aan de hand van de volgende opties:
- day
- sitereference
- currencyiso3a
- requesttypedescription
- accounttypedescription
- paymenttypedescription
- errorcode
- settlestatus
- livestatus
- transactionactive
- enrolled
- fraudcontrolshieldstatuscode
- orderreference
U kunt een voorkeursgroepering toepassen op de Rapport downloaden door het optionele sqlgroupbys veld in het verzoek.
Het volgende voorbeeldverzoek zou uitvoer teruggeven gegroepeerd op Munt eerst en dan Betalingstype:
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&sqlgroupbys=currencyiso3a&sqlgroupbys=paymenttypedescription" https://myst.securetrading.net/auto/transactions/reporting
De volgorde waarin de sqlgroupbys worden ingediend, is van invloed op de uitvoer. De uitvoer wordt altijd gegroepeerd in de volgorde van het verzoek.
U zou er bijvoorbeeld voor kunnen kiezen de uitvoer eerst te groeperen op Betalingstype en dan Muntdoor de twee velden in het bovenstaande voorbeeld om te wisselen.
Bij het indienen van het bovenstaande voorbeeldverzoek zou de uitvoer worden gegroepeerd zoals hieronder getoond. Omdat werd verzocht de gegevens te groeperen op zowel Munt als Betalingstype, is het resultaat dat er een rij in de uitvoer is voor elke combinatie van Munt en Betalingstype.
acquirertypedescription,currencyiso3a,paymenttypedescription,settledcount,sumsettlemainamount
TEST,GBP,VISA,1,10.99
TEST,GBP,MASTERCARD,3,33.96
TEST,EUR,VISA,17,214.10
TEST,EUR,MASTERCARD,7,72.80
Dit hangt af van de gateway waarmee u verbinding maakt om betalingen te verwerken.
Vervang het domein in het gegeven voorbeeld door een van de volgende URL's:
- https://myst.securetrading.net/ (European Gateway)
- https://myst.securetrading.us/ (US Gateway)
Voorbeeld (met gebruik van de Europese Gateway):
https://myst.securetrading.net/auto/transactions/reporting
Uitgang
Als uw verzoek succesvol is, heeft de CSV-uitvoer de volgende structuur:
acquirertypedescription,currencyiso3a,paymenttypedescription,settledcount,sumsettlemainamount
TEST,GBP,VISA,1,10.99
TEST,GBP,MASTERCARD,3,33.96
TEST,EUR,VISA,17,214.10
TEST,EUR,MASTERCARD,7,72.80
