Customers¶

Customer records and stored payment details.

2 endpoints All API groups

Get By Merchant¶

POST /api/Customers/GetByMerchant

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/Customers/GetByMerchant' \
  --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	OK	CustomersReponse

Example response

{
  "Customers": [
    {
      "Id": 1,
      "CustomerId": "<customer-id>",
      "MID": 1,
      "Street": "<street>",
      "City": "<city>",
      "State": "<state>",
      "Zip": "<zip>",
      "Country": "<country>",
      "Phone": "+1-555-0100",
      "Email": "developer@example.com",
      "FirstName": "<first-name>",
      "LastName": "<last-name>",
      "Status": 1,
      "AddedOn": "2026-01-31T12:00:00Z",
      "CustomerSource": "Gateway",
      "CreateDate": "2026-01-31"
    }
  ],
  "ResponseCode": 200,
  "Msg": [
    "<msg>"
  ],
  "verbiage": "<verbiage>",
  "displayMessage": "<display-message>"
}

Customers¶

POST /api/Customers

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/Customers' \
  --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	OK	CustomersReponse

Example response

{
  "Customers": [
    {
      "Id": 1,
      "CustomerId": "<customer-id>",
      "MID": 1,
      "Street": "<street>",
      "City": "<city>",
      "State": "<state>",
      "Zip": "<zip>",
      "Country": "<country>",
      "Phone": "+1-555-0100",
      "Email": "developer@example.com",
      "FirstName": "<first-name>",
      "LastName": "<last-name>",
      "Status": 1,
      "AddedOn": "2026-01-31T12:00:00Z",
      "CustomerSource": "Gateway",
      "CreateDate": "2026-01-31"
    }
  ],
  "ResponseCode": 200,
  "Msg": [
    "<msg>"
  ],
  "verbiage": "<verbiage>",
  "displayMessage": "<display-message>"
}