Our ACH API enables businesses 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 BatchPayoutMerchant 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.

​
Endpoint

GET /3p/api/v2/batch-payouts/merchant/{merchant_user_uuid}/{batch_payout_uuid}

​
Path Parameters

ParameterTypeDescription
merchant_user_uuidstringThe UUID of the merchant user whose payout details you want to retrieve.
batch_payout_uuidstringThe UUID of the batch payout you want to retrieve.

​
Response

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