Transactions Log call via API
Download the transactions via API for a given time frame with needed parameters.
The POST request should contain the following mandatory components:
Step 1. Authorization token via login interface
Before downloading transactions you need to request the authorization token which will be later on used to authorize you as a valid user of your existing Backoffice Portal.
This user is not the merchantid/paymentid used for payment processing.
https://portal.sandbox.payabl.com/api/accounts/auth/login
https://portal.payabl.com/api/accounts/auth/login
Login Request
Field Name | Type | Mandatory |
---|---|---|
username | alphanumeric | ✔ |
password | alphanumeric | ✔ |
username and password is the username/password of the Backoffice portal account.
Login Response
Field Name | Type | Description |
---|---|---|
token | alphanumeric | Your authorization token |
Step 2. Get transactions via download interface
Below are the download URLs for our Live and Test environment ( download )
https://portal.sandbox.payabl.com/api/backoffice/transactionLog_download
https://portal.payabl.com/api/backoffice/transactionLog_download
After receiving the login token via the login interface insert the token in the Header of the download request as follows:
Key | Value |
---|---|
Authorization | "Backoffice "+ [token] |
And then construct your request body with the preferred time span as follows (example for email filter):
{
"datetimeFrom": "2021-03-22T00:00:00",
"datetimeTo": "2021-03-22T23:59:59",
"txLogParams": {"email": ["email address"]}
}
You may find a full list of filter parameters here
Do not use long time period because this will influence the speed of downloading.
In txLogParams you may indicate other fields (customer_id, customer_IP etc).
Response
API call provides a data in text format in response. You can set it to get response as file in a preferred format
Chargeback and Fraud data download via API
You can now import detailed data on Chargebacks and Fraud transactions via the Transaction log API call.
To do so you will need to alter your transaction log call request in the following way:
For Chargebacks
- Generate an authorization token as described above.
- Insert the token in the header of your request.
- Construct your request body with the preferred time span. For chargeback download, please include transaction_type : ['2nd Chargeback', 'Chargeback'] into your request body under "txLogParams", as shown below:
{
"datetimeFrom": "2023-01-01T12:00:0",
"datetimeTo": "2023-02-01T18:00:00",
"txLogParams": {"transaction_type": ["2nd Chargeback", "Chargeback"]}
}
For Fraud
- Generate an authorization token as described above.
- Insert the token in the header of your request.
- Construct your request body with the preferred time span. For fraud download, please enable the following flag "fraud_transactions": ["1"] in your request body under "txLogParams", as shown below:
{
"datetimeFrom": "2023-01-01T12:00:0",
"datetimeTo": "2023-02-01T18:00:00",
"txLogParams": {"fraud_transactions": ["1"]}
}
Please note that you can't use other filters (for example "transaction_type") under "txLogParams" if you enable the "fraud_transactions" flag.
Updated 11 months ago