Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Fetch the dynamic form schema for a Noah payout channel.
Future<NoahGetPayoutChannelFormResponse> getPayoutChannelForm(String channelId)
getPayoutQuote from the schema returned for that customer.
getPayoutChannels may already include an inline formSchema. When they do, use it directly and skip this call.| Parameter | Type | Required | Description |
|---|---|---|---|
channelId | String | Yes | Channel identifier from getPayoutChannels. |
NoahGetPayoutChannelFormResponse - An envelope containing:
| Property | Type | Description |
|---|---|---|
data | NoahGetPayoutChannelFormData | The response payload. |
metadataJson | String? | JSON-encoded response metadata. Read it decoded through the metadata getter. |
NoahGetPayoutChannelFormData:
| Property | Type | Description |
|---|---|---|
formSchema | Map<String, dynamic>? | Getter: the JSON Schema describing the fields to collect, decoded from formSchemaJson. null when absent or malformed. |
formSchemaJson | String? | The raw JSON-encoded schema. Prefer the formSchema getter. |
formMetadata | NoahFormMetadata? | Schema metadata — contentHash: String. |
import 'package:portal_flutter/portal_flutter.dart';
final portal = Portal();
try {
final response = await portal.ramps.noah.getPayoutChannelForm('ch-1');
final schema = response.data.formSchema;
if (schema == null) {
print('Channel requires no recipient form');
} else {
// Render form fields from `schema` per Noah's JSON Schema
print('Schema keys: ${schema.keys.toList()..sort()}');
print('Content hash: ${response.data.formMetadata?.contentHash ?? 'none'}');
}
} on PortalException catch (e) {
print('getPayoutChannelForm failed: [${e.code}] ${e.message}');
}
| Code | Description |
|---|---|
NOT_INITIALIZED | Portal was not initialized |
NOAH_GET_PAYOUT_CHANNEL_FORM_ERROR | Failed to get the channel form — for example the channel id does not exist |
Was this page helpful?