GrailPay enables merchants to receive a single batch payout per day, consolidating multiple transactions into one transfer instead of processing them individually. This streamlines payment operations and reduces transaction costs.

Authentication Route This route is secured with processor and vendor token authentication.

​
How It Works

  • The Batch Merchant Payout process runs daily at 9:10 AM EST.
  • All eligible transfers marked as ready for payout are grouped into a single batch transfer per merchant.
  • If the vendor who onboarded the merchant is subscribed to the MerchantBatchPayout webhook, they will receive a real-time notification when the payout is initiated.
  • The webhook response includes a uuid that uniquely identifies the batch payout.
  • This UUID can then be used to retrieve batch payout details via the Get Batch Merchant Payout endpoint.

​
Response Fields

When fetching details of a batch payout, the response will include the following fields:

  • uuid – The unique identifier of the batch payout.
  • amount – The total payout amount (in cents).
  • trace_id – The ACH identifier for the batch payout, which can be referenced when communicating with banking institutions to track the status of the ACH transfer.
  • payout_status – The current status of the batch payout (e.g., pending, completed, failed).
  • transactions – An array of transactions included in this batch payout, detailing individual payments that were consolidated.

If the processor token is used to retrieve this endpoint, then you will also receive a field called vendor_name and this stores the name of the vendor that onboarded the merchant