Endpoints
Learn how to automatize your reconciliation tasks by integrating the endpoints of our Reconciliation API

Login Endpoint

Example: Merchants API Authentication request body
1
{
2
"accessKey": "[email protected]",
3
"secretKey": "password"
4
}
Copied!
Example: Merchants API Authentication response success
1
{
2
"idUser": 123,
3
"username": "[email protected]",
4
"idMerchant": 456
5
}
Copied!
Example: Merchants API Authentication response failure
1
{
2
"code": 83,
3
"description": "You are not permitted to log in from this location, please contact your account administrator."
4
}
Copied!
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
See this page to learn more about cookies.

Transactions Endpoints

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):
The from and to values are in unixTimeStamp format and the maximum difference between them is up to 60 days. The from value can´t be bigger than the to one.
A basic response has the following format:
{ "data": [], "page": 0, "rows": 0, "maxRows": 50 }
The data field, is an array that will contain multiple JSON objects, one for each transaction. Each with its own details.
The responses from these endpoints will containt up to 50 records per page. In case there are 50 records, you will have to request for the next page using the page parameter in the GET request. Always start with page=0.
The rows field, indicates how many transactions the request returned.
The maxRows field shows the maximum transactions a request can have. In case the field 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.

Deposits Endpoint

Example: Merchants API Deposits Endpoint output
1
{
2
"data": [
3
{
4
"idDeposit": 94582793,
5
"externalId": "newIUnit9499432",
6
"creationDate": "2020-02-13T19:14:43Z",
7
"countryName": "Brazil",
8
"country": "BR",
9
"paymentMethodName": "Banco do Brasil",
10
"paymentMethodCode": "BB",
11
"clientDocument": "12345678901",
12
"clientId": "userId123",
13
"amount": 10.0,
14
"currency": "USD",
15
"requestedAmount": 10.0,
16
"requestedCurrency": "USD",
17
"localAmount": 48.09,
18
"localCurrency": "BRL",
19
"fee": 0.0,
20
"feeCurrency": "USD",
21
"lastChangeDate": "2020-02-13T19:57:10Z",
22
"status": "CANCELLED",
23
"idUser": "300823",
24
"flags": []
25
},
26
{
27
"idDeposit": 94582792,
28
"externalId": "newIUnit91055341",
29
"creationDate": "2020-02-13T19:00:26Z",
30
"countryName": "Mexico",
31
"country": "MX",
32
"paymentMethodName": "Visa",
33
"paymentMethodCode": "VI",
34
"clientDocument": "1234567890",
35
"clientId": "userId124",
36
"amount": 10.0,
37
"currency": "USD",
38
"requestedAmount": 10.0,
39
"requestedCurrency": "USD",
40
"localAmount": 197.43,
41
"localCurrency": "MXN",
42
"fee": 0.0,
43
"feeCurrency": "USD",
44
"lastChangeDate": "2020-02-13T19:20:36Z",
45
"status": "COMPLETED",
46
"idUser": "300824",
47
"flags": []
48
}
49
],
50
"page": 0,
51
"rows": 2,
52
"maxRows": 50
53
}
Copied!
This endpoint allows you to retrieve the details of all your Deposits in a given time.

Deposits Endpoint Parameters

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
Country´s code. Click here to see the list of countries.
paymentMethod
String (max length: 2)
all
Payment Method code. See Payment Methods for its codes.
status
String
all
Transaction´s status. Values:
  • PENDING
  • APPROVED
  • COMPLETED
  • CANCELLED
  • DECLINED
clientDocument
String
all
The customer´s document.

Cashouts Endpoint

Example: Merchants API Cashouts Endpoint output
1
{
2
"data": [
3
{
4
"idCashout": 1770,
5
"externalId": "test123",
6
"creationDate": "2020-01-24T18:17:55Z",
7
"country": "BR",
8
"currency": "USD",
9
"amount": 200.0,
10
"creditedCurrency": "USD",
11
"creditedAmount": 0.0,
12
"merchantCurrency": "USD",
13
"merchantAmount": 0.0,
14
"feeCurrency": "USD",
15
"fee": 0.0,
16
"tax": 0.0,
17
"lastChangeDate": "2020-01-24T18:17:55Z",
18
"status": "PENDING",
19
"clientDocument": "12345678901",
20
"flags": [],
21
"idMerchant": 4,
22
"merchantName": "Merchant Test",
23
"reason": "",
24
"existVoucher": false
25
}
26
],
27
"page": 0,
28
"rows": 1,
29
"maxRows": 50
30
}
Copied!
This endpoint allows you to retrieve the details of all your Cashouts in a given time.

Cashouts Endpoint Parameters

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
Country´s code. Click here to see the list of countries.
status
String
all
Transaction´s status. Values:
  • ON_HOLD
  • PENDING
  • DELIVERED
  • COMPLETED
  • REJECTED
  • CANCELLED
  • DECLINED
clientDocument
String
all
The customer´s document.

Credit and Debit Notes Endpoint

Example: Merchants API Credit and Debit Notes Endpoint output
1
{
2
"data": [
3
{
4
"id": 989851,
5
"externalId": "",
6
"idMerchant": 4,
7
"merchantName": "Merchant Test",
8
"date": "2020-02-13T14:04:53Z",
9
"amount": 1000000.0,
10
"currency": "USD",
11
"type": "GENERIC_CREDIT_NOTE",
12
"description": "test note",
13
"category": "CREDIT"
14
},
15
{
16
"id": 989852,
17
"externalId": "",
18
"idMerchant": 4,
19
"merchantName": "Merchant Test",
20
"date": "2020-02-13T14:05:22Z",
21
"amount": 500.0,
22
"currency": "USD",
23
"type": "CASHOUT_PROCESSING_FEE",
24
"description": "cashout transaction fee debit note",
25
"category": "DEBIT"
26
}
27
],
28
"page": 0,
29
"rows": 2,
30
"maxRows": 50
31
}
Copied!
This endpoint allows you to retrieve the details of all your Credit and Debit Notes in a given time.

Credit and Debit Notes Endpoint Parameters

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

Refunds Endpoint

This endpoint allows you to retrieve the details of all your Refunds in a given time.

Refunds Endpoint Parameters

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
Country´s code. Click here to see the list of countries.
paymentMethod
String (max length: 2)
all
Payment Method code. See Payment Methods for its codes.
status
String
all
Transaction´s status. Values:
  • PENDING
  • COMPLETED
  • CANCELLED
  • WAITING_DETAILS

Chargebacks Endpoint

This endpoint allows you to retrieve the details of all your Chargebacks in a given time.

Chargebacks Endpoint Parameters

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
Country´s code. Click here to see the list of countries.
status
String
all
Transaction´s status. Values:
  • PENDING
  • COMPLETED
  • CANCELLED
  • FAILED

Settlements Endpoint

Example: Merchants API Settlements Endpoint output
1
{
2
"data": [
3
{
4
"id": 3329,
5
"creationDate": "2020-01-06T00:00:00Z",
6
"type": "MANUAL",
7
"currency": "USD",
8
"requestedAmount": 50000.0,
9
"fee": 250.0,
10
"amountToTransfer": 49750.0,
11
"status": "PENDING",
12
"idMerchant": 4,
13
"merchantName": "Merchant Test"
14
},
15
{
16
"id": 3328,
17
"creationDate": "2019-12-13T00:00:00Z",
18
"type": "MANUAL",
19
"currency": "USD",
20
"requestedAmount": 1000000.0,
21
"fee": 0.0,
22
"amountToTransfer": 1000000.0,
23
"status": "PENDING",
24
"idMerchant": 4,
25
"merchantName": "Merchant Test"
26
}
27
],
28
"page": 0,
29
"rows": 2,
30
"maxRows": 50
31
}
Copied!
This endpoint allows you to retrieve the details of all your Settlements in a given time.

Settlements Endpoint Parameters

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

Balance Report Endpoint

Example: Merchants API Balance Report Endpoint output
1
{
2
"data": [
3
{
4
"idMerchant": 4,
5
"depositTotal": 0.0,
6
"cashoutTotal": 0.0,
7
"noteTotal": 0.0,
8
"settlementTotal": 0.0,
9
"cancelledSettlementTotal": 0.0,
10
"depositFeeTotal": 0.0,
11
"netAmount": 0.0,
12
"totalBalance": 104642.98,
13
"date": "2020-01-30T00:00:00Z",
14
"currency": "USD"
15
},
16
{
17
"idMerchant": 4,
18
"depositTotal": 12.5,
19
"cashoutTotal": 0.0,
20
"noteTotal": 0.0,
21
"settlementTotal": 0.0,
22
"cancelledSettlementTotal": 0.0,
23
"depositFeeTotal": 0.1,
24
"netAmount": 12.4,
25
"totalBalance": 104655.38,
26
"date": "2020-01-31T00:00:00Z",
27
"currency": "USD"
28
}
29
],
30
"page": 0,
31
"rows": 2,
32
"maxRows": 50
33
}
Copied!
This endpoint allows you to retrieve the details of your daily Balance Report in a given time.

Balance Report Endpoint Parameters

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.

Total Available Balance Endpoint

This endpoint allows you to retrieve the details of your Total Available Balance.

Logout Endpoint

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.
Once the token was deleted, you will need to authenticate again before sending a new request.