Endpoints
Learn how to automatize your reconciliation tasks by integrating the endpoints of our Reconciliation API
Last updated
Was this helpful?
Learn how to automatize your reconciliation tasks by integrating the endpoints of our Reconciliation API
Last updated
Was this helpful?
Example: Merchants API Authentication request body
Example: Merchants API Authentication response success
Example: Merchants API Authentication response failure
Staging POST
Once your account is ready to use the Merchants API, the first step will be authenticating yourself. This has to be done through a POST request to the login endpoint mentioned above specifying the accessKey (email) and the secretKey (password) in JSON format.
Please see the examples.
Make sure you add in the header of the request the following value: Content-Type: application/json
Once successfully authenticated, along with the response there will come a field in the header called Set-Cookie. This field will contain a cookie called BEARER_TOKEN that has to be sent back to the server in all the following requests to stay logged in.
Example of a cookie in the header with the BEARER_TOKEN value:
cookie: BEARER_TOKEN=U3dcUx8IRJ5nLjb0WYM4cHa3qHFqnrqAk
Described below the endpoints for each kind of transactions.
All the requests sent have to have the BEARER_TOKEN obtained from the Login Endpoint in the Authentication's header field of the requests like follows:
Authorization: Bearer U3dcUx8IRJ5nLjb0WYM4cHa3qHFqnrqAk
Or as a cookie:
cookie: BEARER_TOKEN=U3dcUx8IRJ5nLjb0WYM4cHa3qHFqnrqAk
There are certain parameter you can send in the GET request. These parameters are pairs of names and their corresponding values, so-called name-value pairs. These are added to the URL with a “?” sign. The name and value are always separated using an “=” sign. Multiple parameters can be used. Here, the various parameters are separated using an “&” sign.
The syntax is as follows (examples):
A basic response has the following format:
The data field, is an array that will contain multiple JSON objects, one for each transaction. Each with its own details.
The response from this API uses pagination starting from page=0. Each page can display a maximum of rows defined by "maxRows". To work effectively with this pagination, begin with page=0 and increment the page number by 1 whenever the rows value is equal to maxRows. Continue generating requests for subsequent pages until the number of records retrieved is less than the maximum, indicating the end of the dataset. page parameter will be sent in a GET request.
The rows field, indicates how many transactions the request returned.
The maxRows field shows the maximum transactions a request can retrieve. In case the "rows" is equal to "maxRows", you should do another request specifying the page plus one. Repeat this until the rows value is lesser than the maxRows one.
Example: Merchants API Deposits Endpoint output
This endpoint allows you to retrieve the details of all your Deposits in a given time.
Parameter
Mandatory
Format
Default
Description
from
Integer
null
Transaction creation date interval in UnixTimeStamp format.
to
Integer
null
Transaction creation date interval in UnixTimeStamp format - max difference with "from" value 60 days.
page
Integer
0
The page number. Each page contains as many transactions as indicated in the maxRows value.
country
String (max length: 2)
all
paymentMethod
String (max length: 2)
all
status
String
all
Transaction´s status. Values:
PENDING
APPROVED
COMPLETED
CANCELLED
DECLINED
clientDocument
String
all
The customer´s document.
Example: Merchants API Cashouts Endpoint output
This endpoint allows you to retrieve the details of all your Cashouts in a given time.
Parameter
Mandatory
Format
Default
Description
from
Integer
null
Transaction creation date interval in UnixTimeStamp format.
to
Integer
null
Transaction creation date interval in UnixTimeStamp format - max difference with "from" value 60 days.
page
Integer
0
The page number. Each page contains as many transactions as indicated in the maxRows value.
country
String (max length: 2)
all
status
String
all
Transaction´s status. Values:
ON_HOLD
PENDING
DELIVERED
COMPLETED
REJECTED
CANCELLED
DECLINED
clientDocument
String
all
The customer´s document.
Example: Merchants API Credit and Debit Notes Endpoint output
This endpoint allows you to retrieve the details of all your Credit and Debit Notes in a given time.
Parameter
Mandatory
Format
Default
Description
from
Integer
null
Transaction creation date interval in UnixTimeStamp format.
to
Integer
null
Transaction creation date interval in UnixTimeStamp format - max difference with "from" value 60 days.
page
Integer
0
The page number. Each page contains as many transactions as indicated in the maxRows value.
type
String
all
Cred/deb note types:
GENERIC_CREDIT_NOTE
SERVICE_FEE_CREDIT_NOTE
CHARGEBACK_COVERED_CREDIT_NOTE
GENERIC_DEBIT_NOTE
REFUND
REFUND_PROCESSING_FEE
CASHOUT_TRANSACTION
CASHOUT_PROCESSING_FEE
CHARGEBACK
CHARGEBACK_PROCESSING_FEE
SERVICE_FEE_DEBIT_NOTE
This endpoint allows you to retrieve the details of all your Refunds in a given time.
Parameter
Mandatory
Format
Default
Description
from
Integer
null
Transaction creation date interval in UnixTimeStamp format.
to
Integer
null
Transaction creation date interval in UnixTimeStamp format - max difference with "from" value 60 days.
page
Integer
0
The page number. Each page contains as many transactions as indicated in the maxRows value.
country
String (max length: 2)
all
paymentMethod
String (max length: 2)
all
status
String
all
Transaction´s status. Values:
PENDING
COMPLETED
CANCELLED
WAITING_DETAILS
This endpoint allows you to retrieve the details of all your Chargebacks in a given time.
Parameter
Mandatory
Format
Default
Description
from
Integer
null
Transaction creation date interval in UnixTimeStamp format.
to
Integer
null
Transaction creation date interval in UnixTimeStamp format - max difference with "from" value 60 days.
page
Integer
0
The page number. Each page contains as many transactions as indicated in the maxRows value.
country
String (max length: 2)
all
status
String
all
Transaction´s status. Values:
PENDING
COMPLETED
CANCELLED
FAILED
Example: Merchants API Settlements Endpoint output
This endpoint allows you to retrieve the details of all your Settlements in a given time.
Parameter
Mandatory
Format
Default
Description
from
Integer
null
Transaction creation date interval in UnixTimeStamp format.
to
Integer
null
Transaction creation date interval in UnixTimeStamp format - max difference with "from" value 60 days.
page
Integer
0
The page number. Each page contains as many transactions as indicated in the maxRows value.
status
String
all
Transaction´s status. Values:
PENDING
COMPLETED
CANCELLED
FAILED
Example: Merchants API Balance Report Endpoint output
This endpoint allows you to retrieve the details of your daily Balance Report in a given time.
Parameter
Mandatory
Format
Default
Description
from
Integer
null
Transaction creation date interval in UnixTimeStamp format.
to
Integer
null
Transaction creation date interval in UnixTimeStamp format - max difference with "from" value 60 days.
page
Integer
0
The page number. Each page contains as many transactions as indicated in the maxRows value.
This endpoint allows you to retrieve the details of your Total Available Balance.
The token expires after 15 minutes of its last usage. In case of wanting to terminate the session earlier, you will have to use the above mentioned endpoint with the DELETE method.
This will take the BEARER_TOKEN in the header of the request and invalidate it for future usages.
Production POST
See to learn more about cookies.
Staging
Production
The from and to values are in and the maximum difference between them is up to 60 days. The from value can´t be bigger than the to one.
Staging GET
Production GET
Country´s code. to see the list of countries.
Payment Method code. See for its codes.
Staging GET
Production GET
Country´s code. to see the list of countries.
Staging GET
Production GET
Staging GET
Production GET
Country´s code. to see the list of countries.
Payment Method code. See for its codes.
Staging GET
Production GET
Country´s code. to see the list of countries.
Staging GET
Production GET
Staging GET
Production GET
Staging GET
Production GET
Staging DELETE
Production DELETE
Once the token was deleted, you will need to again before sending a new request.