Overview
The GrailPay Payments API provides several endpoints for retrieving payout information, allowing your systems to monitor,
audit, and reconcile outgoing funds across different entity types. This page outlines how to retrieve both individual
batch payouts and lists of batch payouts for each supported entity type: Business, Merchant, Person, and Processor.
Payouts represent the credit leg of an ACH transfer and are linked to the original transaction that initiated the flow
of funds. These batch-level endpoints are essential for tracking disbursements and ensuring timely reconciliation.
At this time, we do not yet support retrieving an individual (non-batch) payout via a dedicated endpoint. This
functionality is in development and will be added in a future release.
Payout responses now include a modality field that tells you exactly how each payout was sent and how quickly it will
arrive. The modality field contains two pieces of information:
- The method used to send the funds (such as ACH or FedNow)
- The speed at which the transfer will complete
This addition makes it easier to track and report on your payouts, giving you a clearer picture of how money is
moving through our system. You’ll see this field in responses from all payout endpoints, as well as in payout
webhook events.
Retrieve a Batch Payout
Each of the following endpoints is designed to retrieve the details of a specific batch payout, scoped to a particular
entity type — whether it’s a Business, Merchant, Person, or Processor. By providing the unique uuid of a batch payout,
you can access a complete record of that disbursement, including its status, total amount, associated transactions, and
timestamps. These endpoints are essential for teams that need to reconcile payouts, track payment delivery, or build
internal reporting around outgoing funds.
To get the UUID for a batch payout, you need to be subscribed to the appropriate batch payout Webhook Events. Get Batch Business Payout
Use this endpoint to retrieve a batch payout made to a Business entity.
View API Reference → Get Business Batch Payout
Get Batch Merchant Payout
Use this endpoint to retrieve a batch payout made to a Merchant.
View API Reference → Get Merchant Batch Payout
Get Batch Person Payout
Use this endpoint to retrieve a batch payout made to a Person (typically a user that is not a business or merchant).
View API Reference → Get Person Batch Payout
Get Batch Processor Payout
Use this endpoint to retrieve a batch payout made to a Processor account.
View API Reference → Get Processor Batch Payout
Retrieve All Batch Payouts
The following endpoints allow you to retrieve lists of batch payouts, organized by entity type (Business, Merchant,
Person, or Processor). These endpoints support pagination and filtering, making them ideal for reviewing payout
history, reconciling multiple disbursements at once, or powering payout-related dashboards in your internal tools.
Whether you’re tracking recent activity or auditing large volumes of payouts, this functionality provides the flexibility
and visibility needed to stay on top of your outgoing ACH flows.
List Batch Business Payouts
Returns a list of all batch payouts sent to Business entities.
View API Reference → List Business Batch Payouts
List Batch Merchant Payouts
Returns a list of all batch payouts sent to Merchants.
View API Reference → List Merchant Batch Payouts
List Batch Person Payouts
Returns a list of all batch payouts sent to Person entities.
View API Reference → List Person Batch Payouts
List Batch Processor Payouts
Returns a list of all batch payouts made to Processor accounts.
View API Reference → List Processor Batch Payouts
Questions?
If you’re encountering any issues, please reach out to [email protected].
