Introduction

Welcome to the LAW API documentation.

This documentation is designed to help our partners integrate seamlessly with the BMG Money ecosystem. The LAW API is built on RESTful principles, ensuring a predictable and standard interface for interacting with our resources.

Key Features

REST Architecture: Resource-oriented URLs and standard HTTP methods.
Secure: All communication is encrypted via HTTPS.
JSON Standard: Requests and responses are formatted in JSON.
Predictable: Standardized HTTP response codes to indicate API status.

Environments

We provide two environments to assist with your development lifecycle:

Environment	Base URL	Description
Sandbox	`https://sandbox.bmgmoney.com`	Use this for development and testing. No real money or data is moved here.
Production	`https://api.bmgmoney.com`	Live environment. Requests here affect real user accounts.

Note: You must replace the base URL in your requests depending on which environment you are targeting.

Protocol & Standards

HTTPS Only

To ensure the privacy and security of data, the LAW API requires HTTPS for all communication. Any requests made over plain HTTP will be rejected.

Request Headers

For all API requests, please ensure you include the following headers:

{
  "Content-Type": "application/json",
  "Accept": "application/json"
}

HTTP Status Codes

The LAW API uses standard HTTP response codes to indicate the success or failure of an API request.

Code	Title	Description
200	OK	The request was successful and the response body contains the requested data.
400	Bad Request	The request could not be understood or was missing required parameters. Check your payload and validation rules.
429	Too Many Requests	You have performed too many requests in a short period. Please slow down your request rate.
500	Internal Server Error	Something went wrong on our end. Please get in contact with BMG Money support if the issue persists.

Response Format

All API responses are wrapped in a standard Envelope structure. This ensures a consistent experience whether the request succeeds or fails.

Standard Response Structure

Every response will contain the following fields:

Field	Type	Description
`data`	Object / Null	Contains the requested resource if the operation was successful.
`success`	Boolean	`true` if the request was processed successfully, otherwise `false`.
`errors`	Array / Null	A list of error details if `success` is `false`.

Example: Success

{
  "data": {
    "employeeId": "EMP-98765",
    "status": "Active",
    "hireDate": "2023-01-15"
  },
  "success": true,
  "errors": null
}

Example: Error

{
  "data": null,
  "success": false,
  "errors": [
    {
      "code": "INVALID_INPUT",
      "message": "The provided SSN format is incorrect."
    }
  ]
}

Support If you run into issues or have questions regarding the integration, please contact our implementation team at contact@bmgmoney.com.