Bank Payout Processor Fields

Get the dynamic fields required by a specific bank payout solution.

Endpoint Information

Name: Get Bank Payout Details
Method: GET
URL: {{base_url}}/api/v1/get-bank-payout-details/{{solutionId}}?merchantAccountId={{your_account_no}}

Description

Different bank payout providers require different fields (e.g., IBAN vs. Sort Code vs. Routing Number). Use this endpoint to get the schema of required fields for a solution ID.

Authentication

Type: Basic Auth

• Username: App Key
• Password: Secret Key

Path Parameters

Parameter	Type	Required	Description
solutionId	string	Yes	The payout solution ID

Response

Success Response

{
  "success": true,
  "message": "success",
  "data": [
    {
      "name": "Account Name",
      "type": "text",
      "value": null,
      "required": "true",
      "input_name": "accountName"
    },
    {
      "name": "Account Number",
      "type": "text",
      "value": null,
      "required": "true",
      "input_name": "accountNumber"
    }
  ]
}

Usage

Dynamically render a form based on the data array returned. When submitting the Bank Payout request, map these inputs to the processorRequiredFields object.