Payment orchestrators allow business units to take payments and route them to payment providers. Since HatchPay sits between you and Payment Service Providers (PSPs), we do not take payments directly. Therefore, we must know how a business wants their payments to be taken by which entity.

A business unit may configure multiple payment orchestrators depending on their needs — perhaps they use one payment gateway for ACH payments and one payment gateway for credit card transactions. Business units can set the payment orchestrator they use based on their workflow requirements.

Understanding what each part of a payment orchestrator does is important when configuring one for your business unit and ensuring that your payments are processed efficiently. Below is a guide to each payment orchestrator field:

• Payment Gateway: The payment gateway ensures that transactions are properly handled when accepting payments from customers.

• Gateway URL: The gateway URL is the URL to the API required for making requests to the payment gateway attached to the payment orchestrator.

• iFrame URL (optional): The iFrame URL connects HatchPay to its front-end.

• Tokenizer API URL (optional): The tokenizer API URL tokenizes the JSON files that are sent to it.

• Gateway Authentication: The gateway authentication is the credentials required to authenticate into the payment gateway.

Creating a Payment Orchestrator

To create a payment orchestrator within your HatchPay account, you can follow the steps outlined in our Business Unit Setup tutorial. This tutorial will guide you through the process of creating a payment orchestrator, including selecting the appropriate payment gateway, specifying the gateway URL, and configuring any additional fields as needed.

Viewing all Payment Orchestrators

Since all payment orchestrators belong to a business unit, the business unit’s ID is required to view them. The following endpoint may be used to see all payment orchestrators under a business unit: GET /v1/business-unit/business-units/{business_unit_id}/payment-orchestrators

Viewing a specific Payment Orchestrator

If you only want to access a single payment orchestrator under a business unit, use the following endpoint: GET /v1/business-unit/business-units/{business_unit_id}/payment-orchestrators/{payment_orchestrator_id}

Updating a Payment Orchestrator

An individual payment orchestrator can be updated with the following endpoint: PATCH /v1/business-unit/business-units/{business_unit_id}/payment-orchestrators/{payment_orchestrator_id}

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

Deleting a Payment Orchestrator

If you wish to delete a payment orchestrator, you can do so with the following endpoint: DELETE /v1/business-unit/business-units/{business_unit_id}/payment-orchestrators/{payment_orchestrator_id}