Report¶

Transaction reports and report queries.

6 endpoints All API groups

Get Report By Merchant¶

POST /api/Report/GetReportByMerchant

Request body¶

Field	Type	Requirement	Description
`AppKey`	string	Required	Application Key which uniquely identifies your application as provided by the Blackstone system.
`AppType`	integer (int32)	Required	Application Type as provided by the Blackstone system.
`mid`	integer (int32)	Required	Merchant ID – A number used to identify the merchant.
`cid`	integer (int32)	Required	Cashier ID – A number used to identify the merchant’s subclient.
`UserName`	string	Required	User credential of the client on the host.
`Password`	string	Required	Password of the client on the host.
`IpAddress`	string	Optional	—
`Source`	string — `ApiClient`, `BpaydPortal`, `BPaydApp`, `BatchCloser`, `RecurringBillingTask`, `BPaydPlugin`, `PaymentFrame`, `VirtualTerminal`, `PaymentLink`, `Recurring`, `Invoice`, `QuickPayment`, `TakePayment`, `QuickPaymentMobileApp`, `WordPress`, `Zoho`, `Xero`, `Odoo`, `GoHighLevel`, `TakePaymentMobileApp`	Optional	—
`AppInfo`	string	Optional	—
`IsTest`	boolean	Optional	—

cURLJSON

curl --request POST \
  --url 'https://services.bmspay.com/api/Report/GetReportByMerchant' \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "AppKey": "your-app-key",
  "AppType": 1,
  "mid": 1,
  "cid": 1,
  "UserName": "your-username",
  "Password": "your-password",
  "IsTest": true
}
JSON

{
  "AppKey": "your-app-key",
  "AppType": 1,
  "mid": 1,
  "cid": 1,
  "UserName": "your-username",
  "Password": "your-password",
  "IsTest": true
}

Responses¶

Status	Description	Schema
200	The Response	SaleReportResponse

Example response

{
  "Transactions": [
    {
      "ID": 1,
      "MID": 1,
      "CID": 1,
      "SaleType": 1,
      "UserTransactionNumber": "unique-transaction-id",
      "ServiceTransactionNumber": "<service-transaction-number>",
      "Amount": 10.0,
      "CurrencyCode": "USD",
      "AuthCode": "<auth-code>",
      "LastFour": "<last-four>",
      "CardWasSwiped": 1,
      "CardType": "<card-type>",
      "MadeOn": "2026-01-31T12:00:00Z",
      "TransactionRefunded": 1,
      "RefundedAmount": 10.0,
      "RefundedOn": "2026-01-31T12:00:00Z"
    }
  ],
  "ResponseCode": 200,
  "Msg": [
    "<msg>"
  ],
  "verbiage": "<verbiage>",
  "displayMessage": "<display-message>"
}

Get Report By User And Cashier¶

POST /api/Report/GetReportByUserAndCashier

Request body¶

Schema: Request

Field	Type	Requirement	Description
`AppKey`	string	Required	Application Key which uniquely identifies your application as provided by the Blackstone system.
`AppType`	integer (int32)	Required	Application Type as provided by the Blackstone system.
`mid`	integer (int32)	Required	Merchant ID – A number used to identify the merchant.
`cid`	integer (int32)	Required	Cashier ID – A number used to identify the merchant’s subclient.
`UserName`	string	Required	User credential of the client on the host.
`Password`	string	Required	Password of the client on the host.
`IpAddress`	string	Optional	—
`Source`	string — `ApiClient`, `BpaydPortal`, `BPaydApp`, `BatchCloser`, `RecurringBillingTask`, `BPaydPlugin`, `PaymentFrame`, `VirtualTerminal`, `PaymentLink`, `Recurring`, `Invoice`, `QuickPayment`, `TakePayment`, `QuickPaymentMobileApp`, `WordPress`, `Zoho`, `Xero`, `Odoo`, `GoHighLevel`, `TakePaymentMobileApp`	Optional	—
`AppInfo`	string	Optional	—
`IsTest`	boolean	Optional	—

cURLJSON

curl --request POST \
  --url 'https://services.bmspay.com/api/Report/GetReportByUserAndCashier' \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "AppKey": "your-app-key",
  "AppType": 1,
  "mid": 1,
  "cid": 1,
  "UserName": "your-username",
  "Password": "your-password",
  "IsTest": true
}
JSON

{
  "AppKey": "your-app-key",
  "AppType": 1,
  "mid": 1,
  "cid": 1,
  "UserName": "your-username",
  "Password": "your-password",
  "IsTest": true
}

Responses¶

Status	Description	Schema
200	The Response	SaleReportResponse

Example response

{
  "Transactions": [
    {
      "ID": 1,
      "MID": 1,
      "CID": 1,
      "SaleType": 1,
      "UserTransactionNumber": "unique-transaction-id",
      "ServiceTransactionNumber": "<service-transaction-number>",
      "Amount": 10.0,
      "CurrencyCode": "USD",
      "AuthCode": "<auth-code>",
      "LastFour": "<last-four>",
      "CardWasSwiped": 1,
      "CardType": "<card-type>",
      "MadeOn": "2026-01-31T12:00:00Z",
      "TransactionRefunded": 1,
      "RefundedAmount": 10.0,
      "RefundedOn": "2026-01-31T12:00:00Z"
    }
  ],
  "ResponseCode": 200,
  "Msg": [
    "<msg>"
  ],
  "verbiage": "<verbiage>",
  "displayMessage": "<display-message>"
}

Get Unsettled Transactions¶

POST /api/Report/GetUnsettledTransactions

Request body¶

Schema: Request

Field	Type	Requirement	Description
`AppKey`	string	Required	Application Key which uniquely identifies your application as provided by the Blackstone system.
`AppType`	integer (int32)	Required	Application Type as provided by the Blackstone system.
`mid`	integer (int32)	Required	Merchant ID – A number used to identify the merchant.
`cid`	integer (int32)	Required	Cashier ID – A number used to identify the merchant’s subclient.
`UserName`	string	Required	User credential of the client on the host.
`Password`	string	Required	Password of the client on the host.
`IpAddress`	string	Optional	—
`Source`	string — `ApiClient`, `BpaydPortal`, `BPaydApp`, `BatchCloser`, `RecurringBillingTask`, `BPaydPlugin`, `PaymentFrame`, `VirtualTerminal`, `PaymentLink`, `Recurring`, `Invoice`, `QuickPayment`, `TakePayment`, `QuickPaymentMobileApp`, `WordPress`, `Zoho`, `Xero`, `Odoo`, `GoHighLevel`, `TakePaymentMobileApp`	Optional	—
`AppInfo`	string	Optional	—
`IsTest`	boolean	Optional	—

cURLJSON

curl --request POST \
  --url 'https://services.bmspay.com/api/Report/GetUnsettledTransactions' \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "AppKey": "your-app-key",
  "AppType": 1,
  "mid": 1,
  "cid": 1,
  "UserName": "your-username",
  "Password": "your-password",
  "IsTest": true
}
JSON

{
  "AppKey": "your-app-key",
  "AppType": 1,
  "mid": 1,
  "cid": 1,
  "UserName": "your-username",
  "Password": "your-password",
  "IsTest": true
}

Responses¶

Status	Description	Schema
200	The Response	UnsettledTransactionResponse

Example response

{
  "UnsettledTransactions": [
    {
      "id": 1,
      "mid": 1,
      "cid": 1,
      "batch_number": "<batch-number>",
      "UserReferenceNumber": "<user-reference-number>",
      "ServiceReferenceNumber": "<service-reference-number>",
      "SettlementResult": 1,
      "TimeSpan": "2026-01-31T12:00:00Z"
    }
  ],
  "ResponseCode": 200,
  "Msg": [
    "<msg>"
  ],
  "verbiage": "<verbiage>",
  "displayMessage": "<display-message>"
}

Ge Transaction Numbers¶

POST /api/Report/GeTransactionNumbers

Request body¶

Schema: Request

Field	Type	Requirement	Description
`AppKey`	string	Required	Application Key which uniquely identifies your application as provided by the Blackstone system.
`AppType`	integer (int32)	Required	Application Type as provided by the Blackstone system.
`mid`	integer (int32)	Required	Merchant ID – A number used to identify the merchant.
`cid`	integer (int32)	Required	Cashier ID – A number used to identify the merchant’s subclient.
`UserName`	string	Required	User credential of the client on the host.
`Password`	string	Required	Password of the client on the host.
`IpAddress`	string	Optional	—
`Source`	string — `ApiClient`, `BpaydPortal`, `BPaydApp`, `BatchCloser`, `RecurringBillingTask`, `BPaydPlugin`, `PaymentFrame`, `VirtualTerminal`, `PaymentLink`, `Recurring`, `Invoice`, `QuickPayment`, `TakePayment`, `QuickPaymentMobileApp`, `WordPress`, `Zoho`, `Xero`, `Odoo`, `GoHighLevel`, `TakePaymentMobileApp`	Optional	—
`AppInfo`	string	Optional	—
`IsTest`	boolean	Optional	—

cURLJSON

curl --request POST \
  --url 'https://services.bmspay.com/api/Report/GeTransactionNumbers' \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "AppKey": "your-app-key",
  "AppType": 1,
  "mid": 1,
  "cid": 1,
  "UserName": "your-username",
  "Password": "your-password",
  "IsTest": true
}
JSON

{
  "AppKey": "your-app-key",
  "AppType": 1,
  "mid": 1,
  "cid": 1,
  "UserName": "your-username",
  "Password": "your-password",
  "IsTest": true
}

Responses¶

Status	Description	Schema
200	The Response	UsedTransactionNumbers

Example response

{
  "UserReferenceNumbers": [
    "<user-reference-numbers>"
  ],
  "ResponseCode": 200,
  "Msg": [
    "<msg>"
  ],
  "verbiage": "<verbiage>",
  "displayMessage": "<display-message>"
}

Get Last Settlement By Merchant¶

POST /api/Report/GetLastSettlementByMerchant

Request body¶

Schema: Request

Field	Type	Requirement	Description
`AppKey`	string	Required	Application Key which uniquely identifies your application as provided by the Blackstone system.
`AppType`	integer (int32)	Required	Application Type as provided by the Blackstone system.
`mid`	integer (int32)	Required	Merchant ID – A number used to identify the merchant.
`cid`	integer (int32)	Required	Cashier ID – A number used to identify the merchant’s subclient.
`UserName`	string	Required	User credential of the client on the host.
`Password`	string	Required	Password of the client on the host.
`IpAddress`	string	Optional	—
`Source`	string — `ApiClient`, `BpaydPortal`, `BPaydApp`, `BatchCloser`, `RecurringBillingTask`, `BPaydPlugin`, `PaymentFrame`, `VirtualTerminal`, `PaymentLink`, `Recurring`, `Invoice`, `QuickPayment`, `TakePayment`, `QuickPaymentMobileApp`, `WordPress`, `Zoho`, `Xero`, `Odoo`, `GoHighLevel`, `TakePaymentMobileApp`	Optional	—
`AppInfo`	string	Optional	—
`IsTest`	boolean	Optional	—

cURLJSON

curl --request POST \
  --url 'https://services.bmspay.com/api/Report/GetLastSettlementByMerchant' \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "AppKey": "your-app-key",
  "AppType": 1,
  "mid": 1,
  "cid": 1,
  "UserName": "your-username",
  "Password": "your-password",
  "IsTest": true
}
JSON

{
  "AppKey": "your-app-key",
  "AppType": 1,
  "mid": 1,
  "cid": 1,
  "UserName": "your-username",
  "Password": "your-password",
  "IsTest": true
}

Responses¶

Status	Description	Schema
200	The Response	SettlementReportResponse

Example response

{
  "SettlementReports": [
    {
      "AmountSettled": 10.0,
      "CompletedOn": "2026-01-31T12:00:00Z",
      "Batches": []
    }
  ],
  "ResponseCode": 200,
  "Msg": [
    "<msg>"
  ],
  "verbiage": "<verbiage>",
  "displayMessage": "<display-message>"
}

Get Settlements By Date¶

POST /api/Report/GetSettlementsByDate

Request body¶

Schema: ReportRequest

Field	Type	Requirement	Description
`StartDate`	string (date-time)	Optional	—
`EndDate`	string (date-time)	Optional	—
`AppKey`	string	Required	Application Key which uniquely identifies your application as provided by the Blackstone system.
`AppType`	integer (int32)	Required	Application Type as provided by the Blackstone system.
`mid`	integer (int32)	Required	Merchant ID – A number used to identify the merchant.
`cid`	integer (int32)	Required	Cashier ID – A number used to identify the merchant’s subclient.
`UserName`	string	Required	User credential of the client on the host.
`Password`	string	Required	Password of the client on the host.
`IpAddress`	string	Optional	—
`Source`	string — `ApiClient`, `BpaydPortal`, `BPaydApp`, `BatchCloser`, `RecurringBillingTask`, `BPaydPlugin`, `PaymentFrame`, `VirtualTerminal`, `PaymentLink`, `Recurring`, `Invoice`, `QuickPayment`, `TakePayment`, `QuickPaymentMobileApp`, `WordPress`, `Zoho`, `Xero`, `Odoo`, `GoHighLevel`, `TakePaymentMobileApp`	Optional	—
`AppInfo`	string	Optional	—
`IsTest`	boolean	Optional	—

cURLJSON

curl --request POST \
  --url 'https://services.bmspay.com/api/Report/GetSettlementsByDate' \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "AppKey": "your-app-key",
  "AppType": 1,
  "mid": 1,
  "cid": 1,
  "UserName": "your-username",
  "Password": "your-password",
  "IsTest": true
}
JSON

{
  "AppKey": "your-app-key",
  "AppType": 1,
  "mid": 1,
  "cid": 1,
  "UserName": "your-username",
  "Password": "your-password",
  "IsTest": true
}

Responses¶

Status	Description	Schema
200	The Response	SettlementReportResponse

Example response

{
  "SettlementReports": [
    {
      "AmountSettled": 10.0,
      "CompletedOn": "2026-01-31T12:00:00Z",
      "Batches": []
    }
  ],
  "ResponseCode": 200,
  "Msg": [
    "<msg>"
  ],
  "verbiage": "<verbiage>",
  "displayMessage": "<display-message>"
}