Skip to content

API Reference

Explore the Bpayd REST API contract as native documentation. Every build regenerates these pages from the published Swagger/OpenAPI specification.

Base URL: https://services.bmspay.com 106 operations 136 schemas

Production API

These endpoints target the production service. Use IsTest: true and your assigned test credentials when following the Sandbox Guide.

API groups

  • Transactions

    Sales, authorizations, completions, refunds, voids, tokens, and wallet payments.

    24 endpoints

  • Report

    Transaction reports and report queries.

    6 endpoints

  • Reporting

    Operational reporting and settlement data.

    11 endpoints

  • Payment Links

    Create, manage, and inspect hosted payment links.

    8 endpoints

  • Business Settings

    Merchant and application configuration.

    2 endpoints

  • Authentication

    Authenticate API clients and manage access.

    2 endpoints

  • Recurring Billing

    Plans, subscriptions, and scheduled billing.

    7 endpoints

  • ACH Processor

    ACH payment processing and reports.

    3 endpoints

  • Check Processor

    Electronic check processing and reversals.

    3 endpoints

  • EBT Transactions

    EBT transaction processing.

    6 endpoints

  • Gift Card

    Gift card sales, balances, and adjustments.

    6 endpoints

  • Customers

    Customer records and stored payment details.

    2 endpoints

  • Administration

    Administrative operations and account management.

    7 endpoints

  • Fraud Auto Deny Options

    Automatic fraud-denial configuration.

    8 endpoints

  • Monetra Admin

    Monetra administrative operations.

    9 endpoints

  • Signature Capture

    Capture and retrieve transaction signatures.

    2 endpoints

Schemas

Browse the complete request and response schema catalog.

Contract guide

Introduction

The Bpayd provides state-of-the-art solutions to support your payment processing needs. The Bpayd's Software Development Kit (SDK) comprises several methods for processing various transactions on your application, including credit card, debit card, EBT card and gift card payments.

Getting Started

  1. Request credentials to obtain access to the Test Environment. The SDK provides a Test environment for your application testing. To request the necessary testing credentials, you may send an email to: support@bmspay.com.
  2. Please include the following information in your email:
    • Contact Name.
    • Company Name.
    • Contact Phone number.
    • Type of account (i.e., Merchant or Developer).
  3. Conduct application testing. Testing should include, at a minimum: Sale Requests, Reversal Requests, and Refund Requests.
  4. Contact support@bmspay.com to check your testing results.
  5. Once all testing is successfully completed and checked, contact your Sales agent to obtain a Merchant ID (MID) and the necessary credentials to gain access to the Production Environment. The SDK is only accessible to registered merchants. To register, you must apply and obtain a Merchant Services account. Once your account is established, you will be provided with a Merchant ID and a set of credentials to access the Production environment.
  6. You can also explore our integration guides to implement more robust and sophisticated features, such as Checkouts and 3D Secure. Simply follow the guidelines provided in these integration resources:

a) 3D Secure Integration https://app.blackstoneonline.com/documentation/blacktone-3ds-docs.pdf

b) Checkout Guide https://app.blackstoneonline.com/documentation/blackstone-payment-links-checkout-integration-guide.pdf

Environment URL

https://services.bmspay.com

Common Request Parameters

The following parameters are common for all requests.

Name Required Type Description
AppKey Yes string Application Key which uniquely identifies your application asprovided by the Blackstone system.
AppType Yes int Application Type as provided by the Blackstone system.
mid Yes int Merchant ID – A number used to identify the merchant.
cid Yes int Cashier ID – A number used to identify the merchant's subclient.
UserName Yes string User credential of the client on the host.
Password Yes string Password of the client on the host.
## Common Response Elements
The following parameters are common for all responses.
Name Type Description
Msg string Supporting message when the transaction fails. Provides contextual information based on the code received.
ResponseCode Int32 The Response Code is a numeric value that represents the results of the request. 200 represents No Errors. Refer to Appendix A for the Response Codes table.

Response codes

Code Description
1 Invalid Credentials
2 Invalid Host Credentials
3 Transaction Error
4 Impossible to do Settlement
5 Trying to send an unauthorized reference number
6 Impossible to do Refund
7 Impossible to do Void
8 Impossible to create user
9 Impossible to do transaction: Credit Limit exceeded.
10 Impossible to do transaction: Credit Limits for merchant not found.
11 This Merchant Number is not authorized to do this operation.
12 Impossible to add value for this merchant on the automatic settlement
13 Empty Request
14 Impossible to process check, look at the response messages for more details
15 Impossible to process check, Incorrect data passed
16 To void a transaction call the method VoidCheckTransaction
17 To process a transaction call the method ProcessCheck
18 Impossible to do transaction, look at the error message for more details
19 Incorrect data type: field CheckAmount
20 Impossible to do void, transaction not funded on the system
21 Impossible to process check, check processed before
22 Impossible to do void, void processed before
23 Impossible to do void, transaction not found
24 Impossible to do settlement, this merchant is not authorized to execute this operation
25 Impossible to generate token
26 Impossible to do pre authorization
28 This application type is not authorized to execute this task
29 UserTransactionNumber not found
30 UserTransactionNumber null or empty
31 ServiceTransactionNumber not found
50 Preauthorization record not found
51 Preauthorization was not set as closable
52 Referenced Preauthorization record was declined
53 Referenced Preauthorization record was completed before
54 Signature Data is null or empty
57 Cannot update time: Merchant is not enrolled in Automatic Batch Close
200 Operation completed successfully
300 System Error