Transaction export integration
Introduction
This function allows you to gather a list of transactions for a given day or month based on the operation date.
In this mode, you have to send a POST
request containing your order’s parameters over HTTPS
to the Dalenys platform.
In case of successful request, the results will be sent in a compressed CSV file to a callback URL or to an email (depending on whether the parameter MAILTO
or CALLBACKURL
is used).
Refer to the: dedicated exportable columns appendice.
Example of exportTransactions
Here is a server to server request example:
$> curl --request POST --url "https://secure-test.dalenys.com/front/service/rest/export" \
--data "method=exportTransactions" \
--data "params[COMPRESSION]=zip" \
--data "params[DATE]=2016-12" \
--data "params[HASH]=15477dcb8687adf90fa51e418f3c1a2d025f40b177a978c2734514734633b3c4" \
--data "params[IDENTIFIER]=Demo Shop" \
--data "params[MAILTO]=john.doe@email.com" \
--data "params[OPERATIONTYPE]=exportTransactions" \
--data "params[VERSION]=3.0" \
Parameters
-
CALLBACKURL string(1-32)
Web services callback URL (mutually exclusive with
MAILTO
). Exports destination URL.Example: http://mydomain.com/webservices/callbacks
-
COLUMNS string(
Column list to be included in an export. (List of compatible columns)
Example: IDENTIFIER;DATE;TRANSACTIONID;ORDERID;OPERATIONTYPE;AMOUNT;CURRENCY;BILLINGFEES INCL. VAT;EXECCODE;CLIENTEMAIL;CLIENTADDRESS;CARDFULLNAME;CARDTYPE;CARDCOUNTRY;3DSECURE;3DSGLOBALSTATUS;RULE APPLIED;SCHEDULE;RETRY
-
COMPRESSION
zip
,gzip
,bzip
The compression method.
Example: zip
-
DATE date(YYYY-MM)
Required and mutually exclusive with STARTDATE and ENDDATE. Month or day of data to be exported, formatted YYYY-MM or YYYY-MM-DD.
Example: 2016-12
-
ENDDATE date(YYYY-MM-DD)
Required and mutually exclusive with DATE, works in pairs with STARTDATE. Period end date.
Example: 2017-01-31
-
HASH string(64)
The transaction’s hash as described in the dedicated section.
Example: 15477dcb8687adf90fa51e418f3c1a2d025f40b177a978c2734514734633b3c4
-
IDENTIFIER string(1-32)
Your processing account technical identifier.
Example: Demo Shop
-
MAILTO email
Web services callback email (mutually exclusive with
CALLBACKURL
).Example: john.doe@email.com
-
OPERATIONTYPE
exportTransactions
The action you want to process.
Example: payment
-
SCOPE
CLIENTSGROUP
,CLIENT
,ACCOUNT
Account hierarchy to be exported.
Example: CLIENTSGROUP
-
STARTDATE date(YYYY-MM-DD)
Required and mutually exclusive with DATE, works in pairs with ENDDATE. Period start date.
Example: 2016-12-01
-
TIMEZONE string(1-128)
Timezone / default value : UTC. Please see the Data sheet dedicated list of available timezones.
Example: Europe/Paris
-
VERSION
3.0
The API protocol version.
Example: 3.0
Request result
Here is the request result from the platform:
-
EXECCODE string(4)
The operation result code. (See the complete list of execution code)
Example: 0000
-
MESSAGE string(no length limit)
The operation result description linked to
EXECCODE
.Example: The transaction has been accepted
-
OPERATIONTYPE
exportTransactions
The action you want to process.
Example: payment