Payment orchestrators let a business unit take payments and route them to a payment provider. Because HatchPay sits between you and your Payment Service Providers (PSPs), it does not move money itself — it needs to know how you want payments taken and by which gateway. An orchestrator captures exactly that.

A business unit can have multiple orchestrators — for example, one gateway for ACH and another for credit cards — and select the right one per workflow. Each orchestrator is made up of the following:

• Payment Gateway: The provider that actually processes the payment.

• Gateway URL: The API endpoint HatchPay calls to reach the gateway.

• iFrame URL (optional): Used by Invite2Pay to render the gateway’s hosted payment form.

• Tokenizer API URL (optional): Used to tokenize card data before it reaches HatchPay.

• Gateway Authentication: The encrypted credentials used to authenticate with the gateway.

• Payment Methods: The methods this orchestrator accepts, such as CREDIT_CARD or ACH.

A business unit with end-of-day tracking enabled on its orchestrator will have settling transactions stamped with an accounting day.

Creating a Payment Orchestrator

Follow Business Unit Setup, which walks through selecting the gateway, setting the gateway URL, and configuring the remaining fields.

Viewing all Payment Orchestrators

Orchestrators belong to a business unit, so its id is required: GET /v1/business-unit/business-units/{business_unit_id}/payment-orchestrators

Viewing a specific Payment Orchestrator

GET /v1/business-unit/business-units/{business_unit_id}/payment-orchestrators/{payment_orchestrator_id}

Updating a Payment Orchestrator

PATCH /v1/business-unit/business-units/{business_unit_id}/payment-orchestrators/{payment_orchestrator_id}

{
    "name": "Test Payment Orchestrator",
    "payment_methods": ["CREDIT_CARD"]
}

Deleting a Payment Orchestrator

DELETE /v1/business-unit/business-units/{business_unit_id}/payment-orchestrators/{payment_orchestrator_id}