A common recipient payout experience is logging into a payout provider portal and claiming funds.
Nexio has integrated several payout providers while continuing to provide the same portal experience to recipients, including email notifications and a reporting interface.
For a general overview of the Payout product, see Payout in the Getting Started section.
What is a recipient?
A recipient is the individual or business receiving payments. Before paying out to a recipient, a recipient profile must first be created either as a separate step or simultaneously with the payout request.
What is a payout?
A payout is the request from the payer (merchant or business, for example) to fund a recipient’s balance, wallet, or account.
What is a spendback?
See the Spendback overview topic.
What is the recipient's experience?
Depending on the chosen payout provider, the payout experience for recipients does not have to change at all.
What is the payer's experience?
The payer (merchant or business, for example) can keep the exact same experience with the payout provider portal, including manual uploads to the provider's portal.
Nexio adds the option for payers to send payouts to recipients through an integration, and gives them a centralized location to track payouts and access reports in the Nexio Dashboard.
What is the integration experience?
An integrator can leverage Nexio's API to do the following:
- Create a recipient profile to which payments will be sent.
- Retrieve information for one or multiple recipient profiles.
- Create a request to process one or more payout transactions.
- Retrieve details for one or more payout transactions.
The overall payout experience is as follows:
Your application creates a recipient profile (before or during a payout request).
For details about using the API to create a profile, see the Create a recipient, Submit payouts, or Submit payouts using batch file endpoint.
Your application submits a payout request.
For details about using the API to submit a payout request, see the Submit payouts or Submit payouts using batch file endpoint.
The recipient receives an email notification from the payout provider prompting them to log in and accept the payment.
The recipient activates their payout account and selects their preferred transfer method.
The recipient’s transfer method is funded.
The payer (merchant or business, for example) views payout information in the Nexio Dashboard (or using the payout provider portal).
For details about using the API to retrieve information for one or more recipient profiles, see the View a recipient by recipientId, View a recipient by recipientRef, or View recipients endpoint.
For details about using the API to retrieve information for one or more payouts, see the View a payout or View payouts endpoint.
For details about configuring and using webhooks to retrieve payout event information, see Legacy webhooks and event types in the Developer Tools section.
Updated 8 months ago