Statement Report API

Statement Movements API provides access to detailed financial data. It enables merchants to retrieve an overview of their account’s monetary activities within specified time periods. Includes all credits (incoming funds), debits (outgoing payments or fees), and costs.

Request URL

You must invoke a GET request to the following URLs according to your needs.

Production: https://api.bamboopayment.com/v2/api/Reporting/billing-movements
Stage: https://api.stage.bamboopayment.com/v2/api/Reporting/billing-movements

Remember to include your merchant’s Private Key in the request headers.
For more details, check our Authentication Guide.

Request parameters

Property	Type	Mandatory?	Description
`merchantAccount`	`Integer`	Yes	The unique identifier for the merchant account
`from`	`String`	Yes	Start date for the transaction query (format: YYYY-MM-DD)
`to`	`String`	Yes	End date for the transaction query (format: YYYY-MM-DD)
`page`	`Integer`	Yes	Page number for pagination
`pageSize`	`Integer`	Yes	Number of records per page
`columns`	`Array`	No	Array of specific columns to include in the response (empty array returns all columns)

Request example

{
    "merchantAccount": 1,
    "from":"2021-01-01",
    "to":"2021-01-31",
    "page":1,
    "pageSize":10,
    "columns": []
}

Response Parameters

Note

Currently, the API may return information up to D-1 (the previous day). This means that the most recent data available through the API might be from the day before the current date. Please take this into consideration when querying for recent transactions.

Property	Type	Description
`Data`	`Array`	Array of transaction objects
`Data` → `transactionid`	`String`	Transaction ID associated with this financial movement
`Data` → `movementid`	`Integer`	Identifier for the financial movement
`Data` → `created`	`String`	Date and time when the financial movement was created
`Data` → `type`	`String`	Type of transaction (e.g., `Refund`, `Purchase`, `Payout"` , `Fee`, `FX`, `Withdrawal`, `Debit adjustment`, `Credit adjustment`.)
`Data` → `country`	`String`	Country code where the transaction occurred `ISO 3166-1 alpha-2 format`
`Data` → `currency`	`String`	Currency code for the financial movement
`Data` → `sign`	`String`	Indicates if the amount is a credit or debit
`Data` → `amount`	`Integer`	Transaction amount
`Data` → `availabledate`	`String`	Date when the funds become available
`Data` → `referenceid`	`String`	Reference ID for the transaction
`Data` → `endusernotes`	`String`	Any notes associated with the transaction
`Data` → `exchangerate`	`Number`	Exchange rate used (if applicable)
`Data` → `status`	`String`	Current status of the transaction
`Data` → `merchant_account_id`	`Integer`	ID of the merchant account
`Data` → `merchant_account_name`	`String`	Name of the merchant account
`Data` → `merchant_id`	`Integer`	ID of the merchant
`Data` → `merchant_name`	`String`	Name of the merchant
`Data` → `payment_method`	`String`	Payment Method used
`Data` → `payment_media_brand`	`String`	Brand of the payment method (if applicable)
`Data` → `last_status_date`	`String`	Date of the last status update
`Page`	`Integer`	Current page number
`PageSize`	`Integer`	Number of records per page
`Total`	`Integer`	Total number of records matching the query
`Errors`	`Array`	Array of error messages if any occurred during the request processing

Response example

{
  "Response": {
    "Data": [
      {
        "TransactionId": 17041776,
        "Type": "Refund",
        "Created": "2024-08-12T13:44:18.397",
        "Status": "Confirmed",
        "Amount": -1,
        "Currency": "USD",
        "Country": "PE",
        "Transaction_source": "BankTransfer",
        "Tenant": "Global Retail Group",
        "Merchant_account": "ACME Online Store",
        "Payment_method_type": "BankTransfer",
        "Payment_method": null,
        "Card_bin": null,
        "Card_last4": null,
        "Order": "REF123456",
        "Unique_id": null,
        "Authorization_code": null,
        "Installments": 1,
        "Issuer": null,
        "Customer_name": null,
        "Customer_document_type": null,
        "Customer_document_number": null,
        "Customer_email": null
      }
    ],
    "Page": 1,
    "PageSize": 10,
    "Total": 1
  },
  "Errors": []
}

Last modified December 20, 2024