Transaction Search

Use the Transaction Search API to get the history of transactions for a ZibaPay account. This API allows you to retrieve details about transactions, including deposits, withdrawals, and transfers.

List Transactions

GET

/v1/reporting/transactions

Lists transactions. Specify one or more query parameters to filter the transactions that appear in the response.

If you specify one or more optional query parameters, the ending_balance response field is empty. It takes a maximum of three hours for executed transactions to appear in the list transactions call. This call lists transactions for the previous three years.

const query = new URLSearchParams({ 
  transaction_id: 'stringstringstrin',
  transaction_type: 'string', 
  transaction_status: 'string', 
  transaction_amount: 'string',
  transaction_currency: 'string', 
  start_date: 'stringstringstringst',  
  end_date: 'stringstringstringst',  
  payment_instrument_type: 'string',
  store_id: 'string',
  terminal_id: 'string', 
  fields: 'transaction_info',
  balance_affecting_records_only: 'Y', 
  page_size: '100', 
  page: '1'
}).toString();
const resp = await fetch(
https://api.zibapay.com/v1/reporting/transactions?${query},
{
method: 'GET',
headers: {
Authorization: 'Bearer <YOUR_TOKEN_HERE>'
}
}
);
 
const data = await resp.text();
console.log(data);

Get

/refunds/{refund_id}

QUERY PARAMETERS

transaction_id

string 17 .. 19 characters Filters the transactions in the response by a PayPal transaction ID. A valid transaction ID is 17 characters long, except for an order ID, which is 19 characters long.

Note : A transaction ID is not unique in the reporting system. The response can list two transactions with the same ID. One transaction can be balance affecting while the other is non-balance affecting.

transaction_type

string Filters the transactions in the response by a PayPal transaction event code. See Transaction event codes.

response

200 A successful request returns the HTTP 200 OK status code and a JSON response body that lists transactions .

RESPONSE SCHEMA: application/json

transaction_id

Array of objects [ 1 .. 2147483647 ] items An array of transaction detail objects.

account_number

string Filters the transactions in the response by a PayPal transaction event code. See Transaction event codes.

 
{
"transaction_details": [
{
"transaction_info": {
"paypal_account_id": "6STWC2LSUYYYE",
"transaction_id": "5TY05013RG002845M",
"transaction_event_code": "T0006",
"transaction_initiation_date": "2014-07-11T04:03:52+0000",
"transaction_updated_date": "2014-07-11T04:03:52+0000",
"transaction_amount": {
"currency_code": "USD",
"value": "465.00"
},
"fee_amount": {
"currency_code": "USD",
"value": "-13.79"
},
"insurance_amount": {
"currency_code": "USD",
"value": "15.00"
},

List All Balances

GET

/v1/reporting/transactions

List all balances. Specify date time to list balances for that time that appear in the response.

Note:

It takes a maximum of three hours for balances to appear in the list balances call.
This call lists balances upto the previous three years.

QUERY PARAMETERS

as_of_time

Array of objects [ 1 .. 2147483647 ] items An array of transaction detail objects.

currency_code

string [ 20 .. 64 ] characters Show pattern List balances in the response at the date time provided, will return the last refreshed balance in the system when not provided.

{
"crypto_balances": [
{
"asset_symbol": "BTC",
"quantity": "0.00512814"
}
],
"balances": [
{
"currency": "USD",
"primary": true,
"total_balance": {
"currency_code": "USD",
"value": "300.00"
},
"available_balance": {
"currency_code": "USD",
"value": "100.00"
},
"withheld_balance": {
"currency_code": "USD",
"value": "200.00"
}
}
],
"account_id": "DV77JV8VP82XE",
"as_of_time": "2021-02-22T11:35:58Z",
"last_refresh_time": "2021-03-03T16:23:30Z"
}

Response

200 A successful request returns the HTTP 200 OK status code and a JSON response body that lists transactions .

RESPONSE SCHEMA: application/json

Support

If you have any questions or need assistance, please contact our support team at support

Was this page helpful?

Helpful (0)

Not helpful (0)