Skip to main content

Getting Started with Payouts

To begin processing payouts with OrchestratorX, you must first establish accounts with your supported payout processors.

The following diagram illustrates the interaction between your application, the OrchestratorX orchestration layer, and the underlying payout processors.

Configuration Resources​

Implementation requires the OrchestratorX Dashboard for configuration and the API for transaction processing.

Prerequisites​

Before configuring your first payout, ensure you have the following credentials from your Dashboard:

  1. A OrchestratorX account.
  2. An API Key (located in the Developers section).
  3. Your Merchant ID (available on the Home page).

Configuring Payout Processors​

Log in to the OrchestratorX Dashboard and follow these steps to connect your processors.

  1. Navigate to Payout Processors: Select the Payout Processors tab from the sidebar, then choose a processor from the supported list to open the configuration modal.

Payout Processors list

Payout Processors list

  1. Provide Credentials: Enter the authentication keys required by the specific processor to enable communication.

Configuring auth keys for communicating with the processor

Configuring auth keys for communicating with the processor

  1. Enable Payment Methods: Select the specific payout methods (e.g., Bank Transfer, Cards) you intend to use for this processor.

Keep preferred payment methods enabled

Keep preferred payment methods enabled

  1. Confirm Configuration: Once saved, the processor will appear as "Active" in your list.

Successfully configured!

Successfully configured!

Processing Payouts via API​

For testing and initial integration, you can use the OrchestratorX Postman Collection.

  1. Import Collection: Download and import the collection into your Postman workspace.

Import postman collection

Import postman collection

  1. Configure Environment Variables: In the Variables tab, set the following parameters:

    • baseUrl: https://api.orchestratorx.com
    • merchant_id: Your unique merchant identifier.
    • api_key: Your OrchestratorX API secret key.

Updating env variables in postman collection

Updating env variables in postman collection

  1. Execute Payout: Navigate to the Process Payouts section of the collection to send a POST request to the /payouts/create endpoint.

process-payouts-using-saved-payment-methods.md