Get Batch Merchant Payout

GrailPay enables merchants to receive a single batch payout per day, consolidating multiple transactions into one payout instead of processing individual transfers separately. This helps streamline payments and reduce 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.
• At this time, all eligible transfers that are ready for payout are aggregated into a single batch transfer to the receiving merchant.
• If the vendor who onboarded the merchant is subscribed to the MerchantBatchPayout webhook, they will receive a notification when the batch payout is initiated.
• The webhook response includes a UUID that uniquely identifies the specific batch payout.
• This UUID can then be used to retrieve detailed information about the batch payout 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.

📘

Note

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.

Endpoint

Response

{
    "status": true,
    "message": "",
    "data": {
        "uuid": "ec0eb270-b656-4ffe-8799-66508ad48e18",
        "amount": 8900,
        "trace_id": "ach_11kt6v9715jp67t",
        "payout_status": "PAYOUT_COMPLETE",
        "transactions": [
          {
            "transaction_uuid": "9ccf5706-dff0-46c7-bf74-4e34dc998485",
            "amount": 4400,
            "transaction_fee": 0,
            "trace_id": "ach_11kt5sew15jj2dp",
            "capture_status": "CAPTURE_COMPLETE"
          },
          {
            "transaction_uuid": "9ccf577a-921b-431a-9e35-80b7fde5e2bd",
            "amount": 4500,
            "transaction_fee": 0,
            "trace_id": "ach_11kt4f8w15h1dsz",
            "capture_status": "CAPTURE_COMPLETE"
          }
        ],
        "created_at": "2025-02-16 14:15:15",
        "updated_at": "2025-02-18 14:15:15"
    },
    "errors": null,
    "error_code": null
}

Errors & Warnings

{
    "status": false,
    "message": "The batch merchant payout not found.",
    "data": null,
    "errors": null,
    "error_code": null
}