Workflows

Required Workflows

The Required Workflow steps below are required at a minimum. Clients are expected to implement additional workflow logic to handle (where necessary):

1. Recipient management API calls
2. Payment Account management API calls
3. Payment / Transaction status calls
4. Webhooks for payment/transaction status updates

📘

Payments vs Transactions

Payments are created for a Recipient to accept in the Recipient Portal or Widget UI.

Transactions are funds transfers processed immediately for a Recipient.

Payments + Recipient Portal

A payment is created for a recipient to accept in the Recipient Portal. The recipient receives an email notification to enroll in the Recipient Portal to accept payment. Future payments don't require enrollment but would require the recipient to login to accept payment or they can set a default payout method which would automatically transact the payout upon payment creation. The recipient manages their own profile and payment accounts.

Required workflow

1. Create Recipient
2. Create Payment

Payments + Widget UI

A payment is created for a recipient to accept in a Widget UI interface. The Widget UI can be displayed in an iFrame or modal window. The unique URL generated from the Widget request is a one-time use short-lived URL for accepting the specified payment. The recipient can add payment methods that remain part of their profile to be used for future payments.

Required workflow

1. Create Recipient
2. Create Payment
3. Create Widget URL

Transactions

A transaction is a funds transfer processed immediately for a recipient. The client implements the UI/UX workflow for recipient and payment account management.

Required workflow

1. Create Recipient
2. Create Payment Account
3. Create Transaction