Interlace Payout APIs provide a seamless way to transfer funds globally to suppliers, employees, contractors, or your own bank accounts.

The payout process covers all key stages of a cross-border transaction, including verifying beneficiary details, obtaining real-time quotations, validating payout parameters, initiating the transfer, and tracking its completion within a single integrated workflow.

Workflow Overview

A typical payout process includes the following steps:

1. Get required fields for a payee
2. Create or retrieve a payee
3. Get a quotation
4. Check a payout
5. Create a payout transaction
6. Get a payout

Step-by-Step Integration

Step 1 — Get Required Fields for a Payee

Use the Get Payee Required Fields API to retrieve the fields needed to create or update a payee, depending on the target country, payout currency, and payee type.

This step ensures that all mandatory beneficiary information (such as IBAN, routing number, or SWIFT code) is collected before proceeding.

Tip: Required fields vary significantly across regions. Always retrieve the field list dynamically rather than hard-coding them.

Step 2 — Create or Retrieve a Payee

• If the payee does not yet exist in the system, use the Create a Payee API to create one and obtain a unique payeeId.
• If a payee already exists, you may retrieve the existing record using the Get a Payee API or the List All Payees API.

Step 3 — Get a Quotation

Use the Get a Quotation API to obtain a real-time exchange rate, applicable fees, and estimated credited amount. This quotation is typically displayed to the user for confirmation before proceeding with the payout.

Tip: Quotations have a validity period. If expired, a new quotation must be obtained.

Step 4 — Check a Payout

Before initiating a transaction, use the Check a Payout API to validate the request.

This step confirms that the transaction meets operational, compliance, and regulatory requirements, including amount limits, payee eligibility, channel availability, and rate validity.

Note: A successful validation returns a checkId, which is required for creating the transaction.

Step 5 — Create a Transaction

Once the payout is validated, call the Create a Payout Transaction API to initiate the transfer using the verified parameters.

• The request must include the checkId from the previous step.
• The response returns a payoutId, which is used to track the transaction.

Step 6 — Get Transaction Details

Use the Get a Payout API or the List All Payouts API to retrieve the payout status, credited amount, applied fees, and other transaction details.

Note: Common statuses include PENDING, CLOSED, FAILED.

🎉 Congratulations! You've now completed the full payout workflow with Interlace APIs!