Skip to main content
POST
/
3p
/
api
/
v1
/
register
/
person
Onboard a new person ( STABLE )
curl --request POST \
  --url https://api.grailpay.com/3p/api/v1/register/person \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "first_name": "John",
  "last_name": "Doe",
  "email": "abc@abc.com",
  "phone": null,
  "client_reference_id": null,
  "billing_merchant_user_uuid": "9c330a70-84de-46c3-a380-70b34799b1d3",
  "billing_processor_mid": "34234244333",
  "payout_type": "batch",
  "address": {
    "line_1": "20 Elmora Ave",
    "line_2": "",
    "city": "Elizabeth",
    "state": "NJ",
    "zip": "07202"
  },
  "bank_account": {
    "plaid": {
      "access_token": "NJ",
      "account_id": "07202"
    },
    "custom": {
      "account_number": "12345678901234",
      "routing_number": "056008849",
      "account_name": "Jack Jones",
      "account_type": "checking",
      "validate_account_routing": true
    }
  }
}'
{
  "status": true,
  "message": "",
  "data": {
    "client_reference_id": "",
    "uuid": "401c79dd-d38c-4c3a-8edf-1afac5914d2d",
    "first_name": "John",
    "last_name": "Doe",
    "email": "",
    "phone": "",
    "status": "Approved|On Hold|Rejected",
    "payout_type": "individual|batch",
    "address": {
      "street_address": "20 Elmora Ave",
      "additional_address": "",
      "city": "Elizabeth",
      "state": "NJ",
      "country": "US",
      "zip": "07202"
    },
    "created_at": "2024-06-03 15:58:44",
    "updated_at": "2024-06-04 18:30:30",
    "duplicate_uuids": null,
    "valid_account": null
  }
}

Authorizations

Authorization
string
header
required

Sanctum token-based authentication using the Bearer scheme. This is provided by the GrailPay Customer Support Team

Body

application/json
first_name
string
Example:

"John"

last_name
string
Example:

"Doe"

email
integer
Example:

"abc@abc.com"

phone
integer
Example:

null

client_reference_id
string
Example:

null

billing_merchant_user_uuid
string
Example:

"9c330a70-84de-46c3-a380-70b34799b1d3"

billing_processor_mid
string
Example:

"34234244333"

payout_type
string
Example:

"batch"

address
object
bank_account
object

Response

Person registered successfully

status
boolean
Example:

true

message
string
Example:

""

data
object