Letzte Aktualisierung 29/10/2014

5. Automatic download process

You can either download a payment file (transaction results) manually via the back office or download your payment files automatically (through an application).

This chapter describes the automatic file download and the electronic reporting page. Go to Basic Batch for more information on manual file downloads and consulting files in the back office.

5.1 Request URL and parameters

Your application sends an HTTPS request to the following page on our server: https://ogone.test.v-psp.com/ncol/test/payment_download_ncp.asp

(The "test" field indicates it is a TEST URL. Replace "test" by "prod" when working with our production environment.)

The parameters should be sent using the POST method.

Field
Description / Value
PSPID Your affiliation name in our system
USERID Name of your API user
PSWD Password of your API user
level Level of payment selection Possible values:
  • ORDERLEVEL (Default)
  • HISTLEVEL (financial history level)
  • FILELEVEL
ofd Order date ‘from’ day (DD)
ofm Order date ‘from’ month (MM)
ofy Order date ‘from’ year (YYYY)
otd Order date ‘to’ day (DD)
otm Order date ‘to’ month (MM)
oty Order date ‘to’ year (YYYY)
afd Payment date ‘from’ day (DD)
afm Payment date ‘from’ month (MM)
afy Payment date ‘from’ year (YYYY)
atd Payment date ‘to’ day (DD)
atm
Payment date ‘to’ month (MM)
aty
Payment date ‘to’ year (YYYY)
arch Send the value "arch" with this field if your download will contain transactions older than 45 days.
PM
Payment method
BRAND
Card brand
CARDNO
Card/account number
orderID
Your reference for the order
Company
Client company
facname1
Customer name
PAYID
Our system’s reference for the payment
ID
FileID of a previously uploaded file (our system’s reference)
status
List of specific statuses (numeric code) separated by “,”.
OnlyIfProcessed
Indicates that only files with the “Processed” status should be downloaded. If the file is not yet processed, our system will return the message: “File not yet processed: please retry later ...” (to select: OnlyIfProcessed =“1”).
stok
Only in combination with “OnlyIfProcessed”. Select all accepted transactions (status 5, 6, 7, 74, 85, 8, 84, 85, 9, 94, 95) of a processed file (to select: stok=“1”).
sterr
Only in combination with “OnlyIfProcessed”. Select all rejected transactions (status 2, 63, 73, 83, 93) of a processed file (to select: sterr=“1”)
st1
Status 0, 1, 51, 71, 81, 91. (To select: st1=“1”)
st2
Status 2. (To select: st2=“1”)
st3
Status 5. (To select: st3=“1”)
st4
Status 9, 94. (To select: st4=“1”)
st5
“Others” status: all statuses other than the ones in st1, st2, st3, st4 and st6 (to select: st5=“1”)
st6
Status 7, 8, 87, 84 (to select: st6=“1”)
Electronic reporting specification (optional):
Structure
File structure. Possible values:
  • STD (standard)
  • EXT (extended)
  • MNG (file management)
  • DYN (dynamic)
Format
File format. Possible values:
  • XML
  • FIX (fixed length)
  • DEL (delimited)
Sep
Separator in the event that the file format is DEL (delimited). Default separator: “;”.
headers
File download headers (to select: headers=“1”)
GR1
First criterion to group payments together. Possible values:
  • LASTACTION
  • BRAND
  • ORDERDATE
  • PFID (uploaded file reference)
  • PAYMENTMETHOD
  • STATUS
GR2
Second criterion to group payments together. Possible values: see GR1.
GR3
Third criterion to group payments together. Possible values: see GR1.

Important remarks:

  • For the date, you either use ofd, ofm, ofy, otd, otm, oty, to search at the order level (order date) or afd, afm, afy, atd, atm, aty, to search at the history level (payment date). It is mandatory for the date to be sent in your requests, unless the FileID or PAYID is sent.
  • For the statuses, you should only use one of the three following options:
  • status
  • stok, sterr in combination with OnlyIfProcessed
  • st1, st2, st3, st4, st5, st6

Example

The merchant wants to retrieve all orders for which authorisation has been declined with an order date between 1st and 15th June 2007.
<form action="https://ogone.test.v-psp.com/ncol/test/payment_download_ncp.asp" method=POST>
<input type=text name=PSPID value=”FishShop1”>
<input type=text name=USERID value=”FishAPI”>
<input type=text name=PSWD value=”MySecret81”>
<input type=text name=level value=”ORDERLEVEL”>
<input type=text name=ofd value=”01”>
<input type=text name=ofm value=”06”>
<input type=text name=ofy value=”2007”>
<input type=text name=otd value=”15”>
<input type=text name=otm value=”06”>
<input type=text name=oty value=”2007”>
<input type=text name=st2 value=”1”>
</form>

5.2 Format: Electronic reporting

In the Electronic Reporting page (“Electronic Reporting” link in your back-office menu), you can set the format and structure you want to use for electronic reports such as file downloads (when push-reports are activated in your account, the electronic reporting link will give access to a list of your push-reports.)

The file format can be set per user. If you want to change the electronic reporting settings for an API user, you can do so via the User Management page (“Users” link in the menu > “Edit” button next to the API user > “File format >>>” link).

5.2.1 File structure

The structure defines the type of information available for each transaction. The payment result files can be downloaded in 4 different structures: "Standard", Extended", "File management" or “Dynamic”.

The full description of these structures is available via the "More info" link on the Electronic reporting page. Please refer to the links in this page for the XML tag names, description, size and format of the download fields.

5.2.2 File format

There are three different formats for file downloads: delimited, XML and fixed length. The layout and an example for each of these are provided below. The file structure used in the examples is “Standard”.

Delimited

Layout

<DOWNLOAD_REPLY> Beginning of the file
<TRANSMISSION Description string>
Sequential list of payments: each line corresponds to one order. Each field is separated by the separator specified in the “Electronic Reporting” page. Each occurrence of a separator in a field value is replaced by a blank.
<END_TRANSMISSION> End of the payments selection 

Example

<DOWNLOAD_REPLY>
<TRANSMISSION Order Level: - Order date 12/04/2007- Status All except Cancelled by client,Invalid or incomplete->
1651818;order0001;12/4/2007;5;Authorised;testoff;;;Paul Smith;;120.00;EUR;0.00;0.00;CreditCard;VISA;XXXXXXXXXXXX1111;;
1651819;order0002;12/4/2007;5;Authorised;testoff;;;Bill Durand;;56.00;EUR;0.00;0.00;CreditCard;Eurocard;XXXXXXXXXXXX9999;;
<END_TRANSMISSION>


XML

Layout

<?xml version="1.0"?>
<DOWNLOAD_REPLY> Beginning of the file
In the event of an error:
<SYSTEM_ERROR>: System error message
<PARAMS_ERROR>: Parameters error message
<NCERROR>: Numeric error code
or
<WARNING>File not yet processed: please retry later ...</WARNING>
<TRANSMISSION attributes: LEVEL, DESCRIP> Beginning of transmission
<GROUP1 attributes: ACTION, BRAND, FILE, METHOD, STATUS, DATE > Beginning of Group1, up to 3 groups are possible. Attributes depend on the selected group.
<PAYMENT attributes: ID, REF, ORDER, STATUS, LIB, ACCEPT, NCID, NCSTER, PAYDATE, CIE, NAME, COUNTRY, TOTAL, CUR, METHOD, BRAND, CARD, UID, STRUCT, FILEID, ACTION, TICKET, PSPID, DESC> Payment description. The attributes depend on the selected file structure.
</TRANSMISSION> end of transmission
</DOWNLOAD_REPLY> end of file

Example

<?xml version="1.0"?>
<DOWNLOAD_REPLY>
<TRANSMISSION LEVEL="Order" DESCRIP="- Order date 12/04/2007- Status All except Cancelled by client,Invalid or incomplete-">
<PAYMENT ID="1651818" REF="order0001" ORDER="12/4/2007" STATUS="5" LIB="Authorised" ACCEPT="testoff" PAYDATE="" CIE="" NAME="Paul Smith" COUNTRY="" TOTAL="120.00" CUR="EUR" SHIP="0.00" TAX="0.00" METHOD="CreditCard" BRAND="VISA" CARD="XXXXXXXXXXXX1111" STRUCT=""></PAYMENT>
<PAYMENT ID="1651819" REF="order0002" ORDER="12/4/2007" STATUS="5" LIB="Authorised" ACCEPT="testoff" PAYDATE="" CIE="" NAME="Bill Durand" COUNTRY="" TOTAL="56.00" CUR="EUR" SHIP="0.00" TAX="0.00" METHOD="CreditCard" BRAND="Eurocard" CARD="XXXXXXXXXXXX9999" STRUCT=""></PAYMENT>
</TRANSMISSION>
</DOWNLOAD_REPLY> 

Fixed length

Layout

<DOWNLOAD_REPLY> Beginning of the file
<TRANSMISSION Description string>
Sequential list of payments: each line corresponds to one order. The length of each field is described one page you can check via the "More info" link on the Electronic reporting page.
<END_TRANSMISSION> End of the payments selection

Example

<DOWNLOAD_REPLY>
<TRANSMISSION Order Level: - Order date 12/04/2007- Status All except Cancelled by client,Invalid or incomplete->
1651818 order0001 12/4/2007 5 Authorised testoff Paul Smith 120.00EUR 0.00 0.00 CreditCard VISA XXXXXXXXXXXX1111
1651819 order0002 12/4/2007 5 Authorised testoff Bill Durand 56.00EUR 0.00 0.00 CreditCard Eurocard XXXXXXXXXXXX9999
<END_TRANSMISSION>

5.2.3 Extra features

Grouping payments together

You can group payments together in your download, according to certain criteria/values. You can set these criteria in the drop down lists under “Sort by” in the “Electronic Reporting page”. Three different values can be selected, allowing the merchant to create sub-groups. Within a group, payments will be sorted according to the value of the sub-group. For instance:

<GROUP1 FILE="1">
    <GROUP2 STATUS="5">
        <GROUP3 BRAND="EUROCARD">
        <END_GROUP3>
        <GROUP3 BRAND="VISA">
        <END_GROUP3>
    <END_GROUP2>
    <GROUP2 STATUS="2">
        <GROUP3 BRAND="EUROCARD">
        <END_GROUP3>
        <GROUP3 BRAND="VISA">
        <END_GROUP3>
    <END_GROUP2>
<END_GROUP1>

The following example illustrates a Standard (structure), Delimited (format), Sort by File (drop down 1) and Brand (drop down 2) download.

Example

<DOWNLOAD_REPLY>
  <TRANSMISSION Order Level: - Order date 12/04/2007- Status All except Cancelled by client,Invalid or incomplete->
    <GROUP1 FILE="40555">
        <GROUP2 BRAND="EUROCARD">
            1651819;order0002;12/4/2007;5;Authorised;testoff;;;Bill Durand;;56.00;EUR;0.00;0.00;CreditCard;Eurocard;XXXXXXXXXXXX9999;;
            1651821;order0004;12/4/2007;5;Authorised;testoff;;;Mark van Steen;;33.00;EUR;0.00;0.00;CreditCard;Eurocard;XXXXXXXXXXXX9999;;
        <END_GROUP2>
        <GROUP2 BRAND="VISA">
            1651818;order0001;12/4/2007;5;Authorised;testoff;;;Paul Smith;;120.00;EUR;0.00;0.00;CreditCard;VISA;XXXXXXXXXXXX1111;;
            1651820;order0003;12/4/2007;5;Authorised;testoff;;;Jef Geeraerts;;75.10;EUR;0.00;0.00;CreditCard;VISA;XXXXXXXXXXXX1111;;
        <END_GROUP2>
    <END_GROUP1>
    <GROUP1 FILE="40558">
        <GROUP2 BRAND="EUROCARD">
            1651834;order5553;12/4/2007;5;Authorised;testoff;;;John Smith;;75.10;EUR;0.00;0.00;CreditCard;Eurocard;XXXXXXXXXXXX9999;;
        <END_GROUP2>
        <GROUP2 BRAND="VISA">
            1651835;order5555;12/4/2007;5;Authorised;testoff;;;John Doe;;50.32;EUR;0.00;0.00;CreditCard;VISA;XXXXXXXXXXXX1111;;
            1651836;order5558;12/4/2007;5;Authorised;testoff;;;Jane Doe;;86.42;EUR;0.00;0.00;CreditCard;VISA;XXXXXXXXXXXX1111;;
        <END_GROUP2>
    <END_GROUP1>
<END_TRANSMISSION>

Headers

You can indicate whether you want to have payment records with or without headers.

A file without headers contains only the transaction lines. If you want to use the <DOWNLOAD_REPLY>, <TRANSMISSION> or <GROUP> tags, you need to enable the “Headers” box.

Diese Website verwendet Cookies, um Ihnen die beste Nutzer-Erfahrung zu geben. Wenn Sie Cookies nicht akzeptieren möchten, empfehlen wir Ihnen, Ihre Cookie-Einstellungen zu ändern. Klicken Sie auf "Akzeptieren", um alle Cookies von dieser Website zu ermöglichen.

Cookie-einstellungen

Cookies werden verwendet, um die Webseite zu verbessern und Informationen anzubieten, die für Sie von Interesse sind.

Funktionsbezogene Cookies

Funktionsbezogene Cookies sind für das ordnungsgemäße Funktionieren der Webseite nötig. Diese Cookies können nicht deaktiviert werden.

Optimierte

Optimierungscookies ermöglichen es uns, die Nutzung der Webseite zu analysieren, damit wir unsere Webseite bewerten und verbessern können.
Dies ist der Standardwert.

Personalisierte

Personalisierte Cookies werden für Soziale Medien und die erweiterte Personalisierung verwendet. Sie ermöglichen es uns, Ihnen Informationen bezüglich Ihres Unternehmens zu zeigen.


Beispiel für unterstützte Funktionen

  • Ländereinstellung speichern
  • Spracheinstellung speichern

Beispiel für eine unerlaubte Funktion

  • Personenbezogene Daten über Ihren Besuch speichern
  • anonymes Tracking über Google Analytics
  • Tracking zum Zweck der Weitervermarktung

Beispiel für unterstützte Funktionen

  • Ländereinstellung speichern
  • Spracheinstellung speichern
  • Anonymes Tracking über Google Analytics

Beispiel für eine unerlaubte Funktion

  • Personenbezogene Daten über Ihren Besuch speichern
  • Tracking zum Zweck der Weitervermarktung

Beispiel für unterstützte Funktionen

  • Ländereinstellung speichern
  • Spracheinstellung speichern
  • Anonymes Tracking über Google Analytics
  • Auf Ihre Interessen abgestimmte Inhalte bereitstellen
  • Auf Ihre Interessen abgestimmte Inserate bereitstellen
  • Tracking zum Zweck der Weitervermarktung

Beispiel für unerlaubte Funktionen

  • Personenbezogene Daten speichern