Collect Payout Information via Enrollment Link

Learn when and how to collect payout information using enrollment links

Payouts enrollment links provide a secure, hosted experience for collecting bank account information from recipients. By generating a link, you can share a complete enrollment flow with sellers, contractors, affiliates, or any individuals who need to receive payments without building custom onboarding UI. This guide covers when to use payouts enrollment links, how to generate them, and how to track enrollment progress.

Prerequisites

Before writing any code, it's helpful to learn about the following topics.

When to Use Payouts Enrollment Links

Use payouts enrollment links when you need a simple way to collect bank account information from recipients without building custom enrollment UI in your application. Payouts enrollment links are ideal when you want to share an enrollment URL via email, text, or other channels, allowing recipients to provide their payout details on a Payload-hosted page.

By using enrollment links, compliance requirements and sensitive data handling are managed automatically. The link ensures recipients are shown and agree to all required terms, captures necessary attestations, and collects banking information directly within a hosted, secure environment—removing that responsibility from your application.

Common use cases

• Email or SMS Distribution: Send enrollment links directly to recipients through email campaigns, text messages, or messaging platforms
• Minimal Development Requirements: Provide a complete enrollment experience without building custom UI or handling sensitive data in your application
• Multi-Channel Enrollment: Share a single enrollment URL across multiple channels and platforms for flexible recipient onboarding

Generating a Payouts Enrollment Link

Creating a payouts enrollment link is a two-step process: create an intent with the payouts_enrollment_link type, then share the returned URL with the recipient.

• New Recipient
• Existing Account

import payload
pl = payload.Session('secret_key_3bW9...', api_version='v2')
 
# Generate a payouts enrollment link
 
 
 
intent = pl.Intent.create(
    type='payouts_enrollment_link'
)
 
print('Payouts enrollment link:', intent.url)
# Share this URL with recipients via email, SMS, or other channels

import payload
 
pl = payload.Session('secret_key_3bW9...', api_version='v2')
account = pl.Account.create(
    # Create an account first
    name='John Doe',
    type='customer',
)
 
# Generate a payouts enrollment link for the existing account
intent = pl.Intent.create(
    type='payouts_enrollment_link',
    payouts_enrollment_link={
        'payment_method_template': {'account_id': account.id},
    },
)
 
print('Payouts enrollment link:', intent.url)
# When completed, the payment method will be associated with this account

Sending Enrollment Links

You can automatically send payouts enrollment links to recipients via email or SMS by including a send_to object when creating the intent. The send_to object requires a name field and either an email or phone field.

• Send via Email
• Send via SMS

import payload
pl = payload.Session('secret_key_3bW9...', api_version='v2')
 
# Send a payouts enrollment link via email
 
 
 
intent = pl.Intent.create(
    type='payouts_enrollment_link',
    send_to=[
        {
            'name': 'Jane Smith',
            'email': '[email protected]'
        }
    ]
)
 
print('Payouts enrollment link sent to:', intent.send_to[0]['email'])

import payload
pl = payload.Session('secret_key_3bW9...', api_version='v2')
 
# Send a payouts enrollment link via SMS
 
 
 
intent = pl.Intent.create(
    type='payouts_enrollment_link',
    send_to=[
        {
            'name': 'Jane Smith',
            'phone': '+15555551234'
        }
    ]
)
 
print('Payouts enrollment link sent to:', intent.send_to[0]['phone'])

Tracking Enrollment Status

After sharing a payouts enrollment link, you can monitor its status and completion through webhooks and API queries.

Webhook Events

Subscribe to webhook events to track enrollment progress. Configure a webhook to receive notifications when recipients complete enrollment.

Query Intent Status

You can retrieve the intent to check its status and access the results after completion:

import payload
pl = payload.Session('secret_key_3bW9...', api_version='v2')
 
# Query the status of a payouts enrollment intent
 
 
 
intent_id = 'int_abc123def456'
 
intent = pl.Intent.get(intent_id)
 
print('Intent status:', intent.status)
if intent.status == 'finished':
    print('Account ID:', intent.payouts_enrollment_link.results.account_id)
    print('Payment Method ID:', intent.payouts_enrollment_link.results.payment_method_id)

When the intent status is finished, the payouts_enrollment_link.results object will contain:

• account_id - The ID of the account created or used during enrollment
• payment_method_id - The ID of the bank account payment method that was created for receiving payouts

You can now use this payment_method_id to send payouts to the enrolled recipient.

Schema Reference

The following fields are available when creating payouts enrollment links. For complete API reference, see Intent API Reference.

Payouts Enrollment Link Configuration

Available fields when creating the payouts enrollment link:

Next Steps

Enhance your payout recipient enrollment implementation

Send Payouts to Enrolled Recipients

Start sending payouts to enrolled recipients using the payment method IDs returned from completed enrollment links.

Monitor Enrollment Completion

Subscribe to webhook notifications to receive real-time updates when recipients complete enrollment via the link and payment methods are created.

Manage Payment Methods

Use the Payment Methods API to retrieve, update, and manage enrolled payout recipient bank accounts after they complete the enrollment link.

Related articles

• Payouts Enrollment - Embedded Form - Embedded enrollment form alternative
• Payouts Enrollment - Back-End API - Create payment methods directly via API
• Payment Methods API Reference
• Intent API Reference
• Accounts Overview