Authorizations
Sanctum token-based authentication using the Bearer scheme. This is provided by the GrailPay Customer Support Team
Path Parameters
UUID of the user
Body
application/json
Bank Accounts
- POSTValidate bank account and routing number ( STABLE )
- GETGet all bank accounts for a user ( STABLE )
- POSTAdd a new bank account for a user ( STABLE )
- DELDelete a bank account ( STABLE )
- GETFetch the bank account balance ( STABLE )
- GETFetch the transaction history for a bank account. ( STABLE )
- GETGet bank account details ( STABLE )
- POSTAdd bank account. ( SUNSETTING )
- GETGet all bank accounts for a user ( SUNSETTING )
- POSTGet balance approval ( STABLE )
- PUTSwitch default bank account ( STABLE )
- POSTGet User Details by bank account ( STABLE )
Users
- POSTOnboard a new Business or Merchant into the ACH application ( STABLE )
- POSTUpdate Business KYB ( STABLE )
- GETGet User ( STABLE )
- DELDeleting a User ( STABLE )
- GETGet All Users ( STABLE )
- POSTRegister a new business ( DEPRECATED )
- POSTUpdate Business KYB ( DEPRECATED )
- POSTOnboard a new person ( STABLE )
Payouts
- GETGet Business Batch Payout ( STABLE )
- GETList Business Batch Payouts ( STABLE )
- GETGet Merchant Batch Payout ( STABLE )
- GETList Merchant Batch Payouts ( STABLE )
- GETGet Person Batch Payout ( STABLE )
- GETList Person Batch Payouts ( STABLE )
- GETGet Processor Batch Payout ( STABLE )
- GETList Processor Batch Payouts ( STABLE )
- GETGet Batch Payout ( SUNSETTING )
- GETGet All Batch Payouts ( SUNSETTING )
- GETGet Batch Merchant Payout ( SUNSETTING )
- GETFetch a Batch Payout ( Processor Only ) ( SUNSETTING )
Refunds
Transactions
Add a new bank account for a user ( STABLE )
Copy
Ask AI
curl --request POST \
--url https://api.grailpay.com/3p/api/v2/users/{uuid}/bank-accounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"plaid": {
"access_token": "access-token",
"account_id": "account-id"
},
"custom": {
"account_number": "12345678901234567",
"routing_number": 123456789,
"account_name": "John Doe",
"account_type": "checking",
"validate_account_routing": true
},
"account_details": {},
"billing_merchant_user_uuid": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
"billing_processor_mid": "1213121313"
}'Copy
Ask AI
{
"status": true,
"message": "Bank account added successfully",
"data": {
"uuid": "12345678-1234-1234-1234-123456789012",
"user_uuid": "12345678-1234-1234-1234-123456789012",
"account_number": "12345678901234567",
"routing_number": "123456789",
"account_name": "John Doe",
"account_type": "checking",
"aggregator_type": "manual",
"created_at": "2021-09-01 00:00:00",
"is_default": true
},
"errors": null,
"error_code": null
}Bank Accounts
Add a new bank account for a user ( STABLE )
This API adds a new bank account for a user. The request body should contain the necessary bank account details.
POST
/
3p
/
api
/
v2
/
users
/
{uuid}
/
bank-accounts
Add a new bank account for a user ( STABLE )
Copy
Ask AI
curl --request POST \
--url https://api.grailpay.com/3p/api/v2/users/{uuid}/bank-accounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"plaid": {
"access_token": "access-token",
"account_id": "account-id"
},
"custom": {
"account_number": "12345678901234567",
"routing_number": 123456789,
"account_name": "John Doe",
"account_type": "checking",
"validate_account_routing": true
},
"account_details": {},
"billing_merchant_user_uuid": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
"billing_processor_mid": "1213121313"
}'Copy
Ask AI
{
"status": true,
"message": "Bank account added successfully",
"data": {
"uuid": "12345678-1234-1234-1234-123456789012",
"user_uuid": "12345678-1234-1234-1234-123456789012",
"account_number": "12345678901234567",
"routing_number": "123456789",
"account_name": "John Doe",
"account_type": "checking",
"aggregator_type": "manual",
"created_at": "2021-09-01 00:00:00",
"is_default": true
},
"errors": null,
"error_code": null
}⌘I