Get Payout Destination
growsurf_get_participant_payout_destinationRetrieve a participant's payout-destination status across enabled PayPal, Venmo, or Wise providers, including active provider, confirmed email, recipient type, and repair reasons.
Instructions
Get a participant's payout-destination status (by GrowSurf participant ID or email) across every payout provider enabled for the program (PayPal, Venmo, or Wise). For each provider it reports the current status, the confirmed payout email, the legal recipient type, and — when a delivery bounced or a recipient was invalidated — the repair reason. activeProvider is the provider that currently gets paid, or null until the participant confirms one. Targets campaignId if you pass it, otherwise GROWSURF_CAMPAIGN_ID.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| campaignId | Yes | Target program id for this call: the `id` returned by `growsurf_list_campaigns`, not the program name or a share URL. Defaults to GROWSURF_CAMPAIGN_ID when omitted. Program IDs also identify newly created programs without restarting the server. | |
| participantId | No | ||
| participantEmail | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| destinations | No | One entry per enabled payout provider describing the participant's destination for it. | |
| activeProvider | No | The payout provider currently selected, or `null` until the participant confirms one. Provider identifiers are open-ended; current examples include `PAYPAL`, `VENMO`, and `WISECOM`. | |
| enabledProviders | No | Payout provider identifiers enabled for this program. Values are open-ended; current examples include `PAYPAL`, `VENMO`, and `WISECOM`. |