Skip to main content
POST
/
api
/
v3
/
businesses
Onboard a new Business into the ACH application ( STABLE )
curl --request POST \
  --url https://api.grailpay.com/api/v3/businesses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_reference_id": "reference_12345",
  "billing_merchant_uuid": "6a8fc154-1a50-483b-a690-fd1dfaf9408b",
  "billing_processor_mid": "12345678",
  "payout_type": "batch",
  "person": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "phone": "2457856490",
    "address": {
      "line_1": "10554 W Quarles Ave",
      "line_2": "Suite 123",
      "city": "Littleton",
      "state": "CO",
      "zip": "80127"
    }
  },
  "business": {
    "name": "Acme Inc.",
    "trading_name": "Acme Corp",
    "address": {
      "line_1": "10554 W Quarles Ave",
      "line_2": "Suite 123",
      "city": "Littleton",
      "state": "CO",
      "zip": "80127"
    }
  },
  "bank_account": {
    "plaid_account_id": "<string>",
    "plaid_access_token": "<string>",
    "account_number": "9876543210",
    "routing_number": "021000021",
    "account_name": "John Doe",
    "account_type": "checking"
  },
  "actions": {}
}
'
{
  "status": true,
  "message": "This business was onboarded successfully.",
  "data": {
    "business": {
      "uuid": "a77dbb10-3686-4caf-9acd-52b3cc455db2",
      "business_type": "business",
      "name": "Acme Inc.",
      "trading_name": "Acme Corp",
      "payout_type": "batch",
      "client_reference_id": "reference_12345",
      "address": {
        "line_1": "10554 W Quarles Ave",
        "line_2": "Suite 123",
        "city": "Littleton",
        "state": "CO",
        "zip": "80127"
      },
      "timestamps": {
        "created_at": "2024-06-25 13:57:03"
      }
    },
    "relations": {
      "person": {
        "uuid": "7c41f6a2-a4b9-4df8-9225-2c1b7312042e"
      }
    },
    "account_intelligence": {
      "confidence_score": 0.81,
      "decisioning_insights": {
        "account_duplicate": false,
        "days_since_first_seen": -1,
        "days_since_last_transaction": -1,
        "has_negative_transactions": false,
        "has_paid_transactions": false,
        "has_positive_transactions": true,
        "name_match": "yes",
        "phone_number_present": false,
        "valid_routing_number": true
      },
      "version": "v3"
    }
  },
  "errors": null,
  "request_id": "2d6a4c39-8fcf-4d80-9189-b4764eac31f2"
}

Authorizations

​
Authorization
string
header
required

Token-based authentication using Authorization: Bearer <YOUR_API_KEY> provided by the GrailPay Support Team.

Body

application/json
​
client_reference_id
string
Example:

"reference_12345"

​
billing_merchant_uuid
string<uuid>
Example:

"6a8fc154-1a50-483b-a690-fd1dfaf9408b"

​
billing_processor_mid
string
Example:

"12345678"

​
payout_type
enum<string>
Available options:
batch,
individual
Example:

"batch"

​
person
Person Request Object · object

Schema for a person request object

​
business
Business Request Object · object

Schema for a business request object

​
bank_account
object
​
actions
object

Response

The response returned from a successful call to onboard a business.

​
status
boolean
Example:

true

​
message
string
Example:

"This business was onboarded successfully."

​
data
object
​
errors
object | null
Example:

null

​
request_id
string<uuid>
Example:

"2d6a4c39-8fcf-4d80-9189-b4764eac31f2"