Enroll Disburse Account

Overview

The enrollDisburseAccount method registers and verifies a destination account (like a bank account) to receive disbursements from your platform.

Purpose

Use this operation to securely enroll payout destinations.

Scenario	Developer Implementation
Link a vendor's bank account	Call enrollDisburseAccount with their bank details.

Request Fields

Field	Type	Required	Description
merchantPayoutId	string	No	Your internal identifier for the operation.
address	PayoutAddress	Yes	Address information associated with the account.
payoutMethodData	PayoutMethod	No	Specific details of the payout instrument being enrolled.
amount	Money	Yes	The amount to be paid out (if enrolling inline).
customer	Customer	No	Details about the customer/account holder.
accessToken	SecretString	No	Access token for the connector, if required.

Response Fields

Field	Type	Required	Description
merchantPayoutId	string	No	Your internal identifier.
payoutStatus	PayoutEnums.PayoutStatus	No	The status of the enrollment.
connectorPayoutId	string	No	The unique identifier assigned by the connector.
error	ErrorInfo	No	Details of any error that occurred.
statusCode	uint32	Yes	The HTTP status code returned from the connector.

Example

SDK Setup

import com.hyperswitch.prism.PayoutClient;
import java.util.Map;
import java.util.HashMap;

PayoutClient payoutClient = PayoutClient.builder()
    .connector("stripe")
    .apiKey("YOUR_API_KEY")
    .environment("SANDBOX")
    .build();

Request

Map<String, Object> request = new HashMap<>();
request.put("amount", Map.of("minorAmount", 0, "currency", "USD"));
request.put("payoutMethodData", Map.of("ach", Map.of("bankAccountNumber", "000123456789", "bankRoutingNumber", "110000000")));

Response response = payoutClient.enrollDisburseAccount(request);

Response

{
    "payoutStatus": "SUCCESS",
    "connectorPayoutId": "ba_1Hh1XYZ2eZvKYlo2C",
    "statusCode": 200
}

Next Steps

• Transfer Payout