Skip to main content
PATCH
/
api
/
v3
/
merchants
/
{uuid}
Update a Merchant into the ACH application ( STABLE )
curl --request PATCH \
  --url https://api.grailpay.com/api/v3/merchants/{uuid} \
  --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": "[email protected]",
    "phone": "2457856490",
    "address": {
      "line_1": "10554 W Quarles Ave",
      "line_2": "Suite 123",
      "city": "Littleton",
      "state": "CO",
      "zip": "80127"
    }
  },
  "merchant": {
    "name": "Acme Inc.",
    "tin": "123456789",
    "trading_name": "Acme Corp",
    "entity_type": "Sole Trader",
    "address": {
      "line_1": "10554 W Quarles Ave",
      "city": "Littleton",
      "state": "CO",
      "zip": "80127",
      "line_2": "Suite 123"
    },
    "incorporation_date": "2024-02-02",
    "incorporation_state": "CO",
    "address_type": "Registered",
    "transaction_fee_percent": 2.5,
    "transaction_fee_fixed": 100,
    "maximum_transaction_fee": 5000
  },
  "beneficial_owners": [
    {
      "first_name": "Jane",
      "last_name": "Doe",
      "dob": "2023-04-11",
      "ssn9": "123456789",
      "address": {
        "line_1": "10554 W Quarles Ave",
        "city": "Littleton",
        "state": "CO",
        "zip": "80127",
        "line_2": "Suite 123"
      },
      "is_beneficial_owner": true,
      "is_director": false,
      "is_significant_control_person": false,
      "ownership_percentage": 25,
      "email": "[email protected]",
      "phone": "2457856490",
      "occupation": "Co-founder"
    }
  ],
  "bank_account": {
    "plaid_account_id": "<string>",
    "plaid_access_token": "<string>",
    "account_number": "9876543210",
    "routing_number": "021000021",
    "account_name": "John Doe",
    "account_type": "checking"
  },
  "actions": {
    "account_intelligence": {
      "version": "v3",
      "name_match": true
    }
  }
}
'
{
  "status": true,
  "message": "This merchant was updated successfully.",
  "data": {
    "merchant": {
      "uuid": "c6bcfbbb-98ff-4d8b-a8f5-1559c3dcb718",
      "business_type": "merchant",
      "kyb_status": "IN_REVIEW",
      "kyb_rejected_reason": null,
      "name": "Acme Inc.",
      "tin": "123456789",
      "trading_name": "Acme Corp",
      "entity_type": "Sole Trader",
      "incorporation_date": "2024-02-02",
      "incorporation_state": "CO",
      "address_type": "Registered",
      "address": {
        "line_1": "10554 W Quarles Ave",
        "line_2": "Suite 123",
        "city": "Littleton",
        "state": "CO",
        "zip": "80127"
      },
      "transaction_fee_percent": 2.5,
      "transaction_fee_fixed": 100,
      "maximum_transaction_fee": 5000,
      "payout_type": "batch",
      "client_reference_id": "reference_12345",
      "timestamps": {
        "created_at": "2024-06-25 13:57:03"
      }
    },
    "beneficial_owners": [
      {
        "first_name": "Jane",
        "last_name": "Doe",
        "dob": "2023-04-11",
        "ssn9": "123456789",
        "address": {
          "line_1": "10554 W Quarles Ave",
          "line_2": "Suite 123",
          "city": "Littleton",
          "state": "CO",
          "zip": "80127"
        },
        "is_beneficial_owner": true,
        "is_director": false,
        "is_significant_control_person": false,
        "ownership_percentage": 25,
        "email": "[email protected]",
        "phone": "2457856490",
        "occupation": "Co-founder",
        "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.

Path Parameters

​
uuid
string<uuid>
required

merchant UUID

Example:

"7c41f6a2-a4b9-4df8-9225-2c1b7312042e"

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

​
merchant
Merchant Request Object · object

Schema for a merchant request object

​
beneficial_owners
Beneficial Owner Request Object · object[]
​
bank_account
object
​
actions
object

Response

The response returned from a successful call to update a merchant.

​
status
boolean
Example:

true

​
message
string
Example:

"This merchant was updated successfully."

​
data
object
​
errors
object
Example:

null

​
request_id
string<uuid>
Example:

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