Administration¶

Administrative operations and account management.

7 endpoints All API groups

Add User To Processor¶

POST /api/Administration/AddUserToProcessor

Request body¶

Field	Type	Requirement	Description
`AppInfo`	string	Optional	Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33"
`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.
`CardTypes`	string	Optional	Card Types.
`ExtraData`	string	Optional	Extra Data.
`ExtraFielsKeys`	string	Optional	Extra Fiels Keys.
`ExtraFielsValues`	string	Optional	Extra Fiels Values.
`FraudAutodenyOptions`	string	Optional	Fraud Auto Deny Options.
`IndustryCode`	string — `A`, `AE`, `AF`, `E`, `F`, `FE`, `G`, `GE`, `H`, `M`, `R`, `RS`	Optional	Industry Code.
`IpAddress`	string	Optional	The client's IP address.
`IsTest`	boolean	Optional	True if is a test sale
`NewPass`	string	Optional	New Password.
`NewUser`	string	Optional	New User.
`Password`	string	Required	Password of the client on the host.
`Processor`	string — `FirstDataOmaha`, `FirsDataGift`, `FirstDataSouth`, `FirstDataNashville`, `AmexAuth`, `AmexPIP`, `BuyPass`, `CardNet`, `Certegy`, `CertegyEcc`, `CertegyImgRepo`, `ChochStone`, `Echk`, `Elavon`, `ElavonDirectnet`, `ElavonClearingFile`, `FifthThirdBank510`, `FifthThirdBank610`, `Gers`, `Givex`, `GlobalPaymentsEast`, `GlobalPaymentsBigBatch`, `Heartland`, `Litle`, `Loopback`, `Mercury`, `MonetraGift`, `Nova`, `BankOfAmerica`, `ChaseTampa`, `RBSLynk`, `ChaseSalem`, `SecureNet`, `Svs`, `FirstDataTelecheck`, `FirstDataTelecheckImgRepo`, `Valutec`, `Vital`, `IntuitImgRepo`, `RapidConnect`	Optional	Processor.
`ProcessorExtraFields`	ProcessorExtraFields	Optional	Processor Extra Fields.
`ProcessorId`	integer (int32)	Optional	Processor Identifier.
`Source`	string — `ApiClient`, `BpaydPortal`, `BPaydApp`, `BatchCloser`, `RecurringBillingTask`, `BPaydPlugin`, `PaymentFrame`, `VirtualTerminal`, `PaymentLink`, `Recurring`, `Invoice`, `QuickPayment`, `TakePayment`, `QuickPaymentMobileApp`, `WordPress`, `Zoho`, `Xero`, `Odoo`, `GoHighLevel`, `TakePaymentMobileApp`	Optional	The source of the request
`UserName`	string	Required	User credential of the client on the host.
`cid`	integer (int32)	Required	Cashier ID – A number used to identify the merchant’s subclient.
`mid`	integer (int32)	Required	Merchant ID – A number used to identify the merchant.

cURLJSON

curl --request POST \
  --url 'https://services.bmspay.com/api/Administration/AddUserToProcessor' \
  --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 Added User Response	AddUserResponse

Example response

{
  "MonetraResponse": "<monetra-response>",
  "Msg": [
    "<msg>"
  ],
  "ResponseCode": 200,
  "displayMessage": "<display-message>",
  "verbiage": "<verbiage>"
}

Delete User From Processor¶

POST /api/Administration/DeleteUserFromProcessor

Request body¶

Schema: DeleteUserRequest

Field	Type	Requirement	Description
`AppInfo`	string	Optional	Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33"
`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.
`IpAddress`	string	Optional	The client's IP address.
`IsTest`	boolean	Optional	True if is a test sale
`Password`	string	Required	Password of the client on the host.
`ProcessorId`	integer (int32)	Optional	Processor Identifier.
`Source`	string — `ApiClient`, `BpaydPortal`, `BPaydApp`, `BatchCloser`, `RecurringBillingTask`, `BPaydPlugin`, `PaymentFrame`, `VirtualTerminal`, `PaymentLink`, `Recurring`, `Invoice`, `QuickPayment`, `TakePayment`, `QuickPaymentMobileApp`, `WordPress`, `Zoho`, `Xero`, `Odoo`, `GoHighLevel`, `TakePaymentMobileApp`	Optional	The source of the request
`UserName`	string	Required	User credential of the client on the host.
`cid`	integer (int32)	Required	Cashier ID – A number used to identify the merchant’s subclient.
`mid`	integer (int32)	Required	Merchant ID – A number used to identify the merchant.

cURLJSON

curl --request POST \
  --url 'https://services.bmspay.com/api/Administration/DeleteUserFromProcessor' \
  --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 Deleted User Response	DeleteUserResponse

Example response

{
  "Msg": [
    "<msg>"
  ],
  "ProcessorResponse": "<processor-response>",
  "ResponseCode": 200,
  "displayMessage": "<display-message>",
  "verbiage": "<verbiage>"
}

Get Credentials¶

POST /api/Administration/GetCredentials

Request body¶

Schema: GetCredentialsRequest

Field	Type	Requirement	Description
`AppInfo`	string	Optional	Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33"
`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.
`ExtraData`	string	Optional	Extra Data.
`IpAddress`	string	Optional	The client's IP address.
`IsTest`	boolean	Optional	True if is a test sale
`Password`	string	Required	Password of the client on the host.
`ProcessorId`	integer (int32)	Optional	Processor Identifier.
`Source`	string — `ApiClient`, `BpaydPortal`, `BPaydApp`, `BatchCloser`, `RecurringBillingTask`, `BPaydPlugin`, `PaymentFrame`, `VirtualTerminal`, `PaymentLink`, `Recurring`, `Invoice`, `QuickPayment`, `TakePayment`, `QuickPaymentMobileApp`, `WordPress`, `Zoho`, `Xero`, `Odoo`, `GoHighLevel`, `TakePaymentMobileApp`	Optional	The source of the request
`UserName`	string	Required	User credential of the client on the host.
`cid`	integer (int32)	Required	Cashier ID – A number used to identify the merchant’s subclient.
`mid`	integer (int32)	Required	Merchant ID – A number used to identify the merchant.

cURLJSON

curl --request POST \
  --url 'https://services.bmspay.com/api/Administration/GetCredentials' \
  --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 Get Credentials Response	GetCredentialsResponse

Example response

{
  "Msg": [
    "<msg>"
  ],
  "Password": "your-password",
  "ResponseCode": 200,
  "UserName": "your-username",
  "displayMessage": "<display-message>",
  "verbiage": "<verbiage>"
}

Get SubAccounts¶

POST /api/Administration/GetSubAccounts

Request a list of cashiers (subaccounts).

Request body¶

Schema: Request

Field	Type	Requirement	Description
`AppInfo`	string	Optional	Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33"
`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.
`IpAddress`	string	Optional	The client's IP address.
`IsTest`	boolean	Optional	True if is a test sale
`Password`	string	Required	Password of the client on the host.
`Source`	string — `ApiClient`, `BpaydPortal`, `BPaydApp`, `BatchCloser`, `RecurringBillingTask`, `BPaydPlugin`, `PaymentFrame`, `VirtualTerminal`, `PaymentLink`, `Recurring`, `Invoice`, `QuickPayment`, `TakePayment`, `QuickPaymentMobileApp`, `WordPress`, `Zoho`, `Xero`, `Odoo`, `GoHighLevel`, `TakePaymentMobileApp`	Optional	The source of the request
`UserName`	string	Required	User credential of the client on the host.
`cid`	integer (int32)	Required	Cashier ID – A number used to identify the merchant’s subclient.
`mid`	integer (int32)	Required	Merchant ID – A number used to identify the merchant.

cURLJSON

curl --request POST \
  --url 'https://services.bmspay.com/api/Administration/GetSubAccounts' \
  --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 SubAccount Response	MerchantSubAccountsResponse

Example response

{
  "Msg": [
    "<msg>"
  ],
  "ResponseCode": 200,
  "SubAccounts": [
    {
      "CanSale": false,
      "DataWireId": "<data-wire-id>",
      "DataWireIdBackUp": "<data-wire-id-back-up>",
      "WebsitePaymentsCount": 1,
      "createdOn": "2026-01-31T12:00:00Z",
      "description": "<description>",
      "first_name": "<first-name>",
      "host_pass": "<host-pass>",
      "host_user": "<host-user>",
      "id": 1,
      "in_black_list": false,
      "isDemo": false,
      "is_enable": false,
      "last_name": "<last-name>",
      "mid": 1,
      "picture_link": "<picture-link>"
    }
  ],
  "displayMessage": "<display-message>",
  "verbiage": "<verbiage>"
}

Remove Merchant From Automatic Close Batch¶

POST /api/Administration/RemoveMerchantFromAutomaticCloseBatch

Request to unsubscribe from automatic batch closing.

CAUTION:

Removing the automatic batch closing option requires a merchant to close each batch manually so that payments can be settled and deposited in the merchant account.Failure to close a batch will result in the return of payments to the payer.

Request body¶

Schema: Request

Field	Type	Requirement	Description
`AppInfo`	string	Optional	Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33"
`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.
`IpAddress`	string	Optional	The client's IP address.
`IsTest`	boolean	Optional	True if is a test sale
`Password`	string	Required	Password of the client on the host.
`Source`	string — `ApiClient`, `BpaydPortal`, `BPaydApp`, `BatchCloser`, `RecurringBillingTask`, `BPaydPlugin`, `PaymentFrame`, `VirtualTerminal`, `PaymentLink`, `Recurring`, `Invoice`, `QuickPayment`, `TakePayment`, `QuickPaymentMobileApp`, `WordPress`, `Zoho`, `Xero`, `Odoo`, `GoHighLevel`, `TakePaymentMobileApp`	Optional	The source of the request
`UserName`	string	Required	User credential of the client on the host.
`cid`	integer (int32)	Required	Cashier ID – A number used to identify the merchant’s subclient.
`mid`	integer (int32)	Required	Merchant ID – A number used to identify the merchant.

cURLJSON

curl --request POST \
  --url 'https://services.bmspay.com/api/Administration/RemoveMerchantFromAutomaticCloseBatch' \
  --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 Remove Merchant From Automatic Close Batch Response	Response

Example response

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

Set Automatic Batch Close¶

POST /api/Administration/SetAutomaticBatchClose

Request to enroll in automatic batch closing and set the time for the daily closing.

NOTE: By default, merchants are enrolled in Automatic Batch Closing with a default automatic batch closing time of 5:00 PM(17:00 military time).

Request body¶

Schema: AutomaticBatchCloseRequest

Field	Type	Requirement	Description
`AppInfo`	string	Optional	Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33"
`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.
`IpAddress`	string	Optional	The client's IP address.
`IsTest`	boolean	Optional	True if is a test sale
`Password`	string	Required	Password of the client on the host.
`Source`	string — `ApiClient`, `BpaydPortal`, `BPaydApp`, `BatchCloser`, `RecurringBillingTask`, `BPaydPlugin`, `PaymentFrame`, `VirtualTerminal`, `PaymentLink`, `Recurring`, `Invoice`, `QuickPayment`, `TakePayment`, `QuickPaymentMobileApp`, `WordPress`, `Zoho`, `Xero`, `Odoo`, `GoHighLevel`, `TakePaymentMobileApp`	Optional	The source of the request
`Time`	string (date-time)	Optional	The time of day for the automatic batch closing to occur.If the merchant was not enrolled in automatic batch closing, the Automatic Batch Close option is set to the specified time.If the merchant already had a closing time specified, no action is taken.
`UserName`	string	Required	User credential of the client on the host.
`cid`	integer (int32)	Required	Cashier ID – A number used to identify the merchant’s subclient.
`mid`	integer (int32)	Required	Merchant ID – A number used to identify the merchant.

cURLJSON

curl --request POST \
  --url 'https://services.bmspay.com/api/Administration/SetAutomaticBatchClose' \
  --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 Set Automatic Batch Close Response	Response

Example response

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

Update Automatic Hour To Close Batch¶

POST /api/Administration/UpdateAutomaticHourToCloseBatch

Request to change the automatic batch closing time. To change the time, the merchant must already be enrolled in automatic batch closing.Otherwise, an error message is returned.

Request body¶

Schema: AutomaticBatchCloseRequest

Field	Type	Requirement	Description
`AppInfo`	string	Optional	Application information including language, version, platform, device model and OS. Format: "Lang: XX. Version: X.X.X. Platform: XXXX. DeviceModel: XXXX. OS: XXXX" Example: "Lang: Es. Version: 3.11.8. Platform: android. DeviceModel: dedede. OS: Android OS 13 / API-33"
`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.
`IpAddress`	string	Optional	The client's IP address.
`IsTest`	boolean	Optional	True if is a test sale
`Password`	string	Required	Password of the client on the host.
`Source`	string — `ApiClient`, `BpaydPortal`, `BPaydApp`, `BatchCloser`, `RecurringBillingTask`, `BPaydPlugin`, `PaymentFrame`, `VirtualTerminal`, `PaymentLink`, `Recurring`, `Invoice`, `QuickPayment`, `TakePayment`, `QuickPaymentMobileApp`, `WordPress`, `Zoho`, `Xero`, `Odoo`, `GoHighLevel`, `TakePaymentMobileApp`	Optional	The source of the request
`Time`	string (date-time)	Optional	The time of day for the automatic batch closing to occur.If the merchant was not enrolled in automatic batch closing, the Automatic Batch Close option is set to the specified time.If the merchant already had a closing time specified, no action is taken.
`UserName`	string	Required	User credential of the client on the host.
`cid`	integer (int32)	Required	Cashier ID – A number used to identify the merchant’s subclient.
`mid`	integer (int32)	Required	Merchant ID – A number used to identify the merchant.

cURLJSON

curl --request POST \
  --url 'https://services.bmspay.com/api/Administration/UpdateAutomaticHourToCloseBatch' \
  --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 Update Automatic Hour To Close Batch Response	Response

Example response

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