Payout Links are one-time use links to send a payout to a recipient. You can email or text the link to your recipient. If conducting a card payout, funds are usually available in minutes.
You can use payout links to send insurance payouts, sales commissions, and more. You can customize the payout link with your brand name and logo.
Recipient Experience
When a recipient clicks on the link, they'll see a where they can enter their card or bank information to receive their payout. This experience can be white-labeled to have your brand colors and logo.
-
Personal Recipients:
For personal recipients,
first_name
,last_name
, andpersonal_address
are required in addition to the payment instrument. -
Business Recipient:
For business recipients,
business_name
,doing_business_as
, andbusiness_address
are required. In addition, we require a control owner withfirst_name
,last_name
, andpersonal_address
.
Once they enter their information, Finix will review and conduct standard underwriting checks. If the recipients are approved, a card or bank payout will be sent.
Recipients can re-visit the link to check the status of their payout. If the payout fails, they'll be asked to re-enter their information. If the recipient is under Manual Review, we may need additional documentation to clear the recipient. Please see our verification process guide for more details.
Create a Payout Link using the Finix Dashboard
You can create a payout link in the Finix Dashboard without any development work. Using the Finix Dashboard, you can:
- Create and send payout links to recipients to receive funds
- Track the status of payout links.
Step 1: Create a Payout Link
To create a payout link in the Finix Dashboard:
- Log into the Finix Dashboard.
- Click Payout Link on the left navigation bar.
- Click Create Payout Link
- Fill out the form with the requested details. Be sure to include a link to your Terms of Service.
Step 2. Send Payout Link to Recipient
On the Payout Link Details page, you can copy the payout link URL to send to buyers.
When the recipient clicks on the link, they will be redirected to Finix's payout form to complete their payout.
Here's an example of a payout link URL:
https://live.sandbox-payments-checkout.com/payout_link?bearer_token=MDE4ZjJkNjQtMDNmMy03Zjg2LTlhMmMtN2E5YzJmOTU4M2E0LVBBWU9VVF9MSU5L
Step 3: Track your Payout Link
After you create a payout link, you can track the payout link status on the Finix Dashboard. You can review the information again on the Finix Dashboard. On the detail page, you can copy the URL again or deactivate a payout link.
If you click on Payout Attempts, you can view payout attempts
in a PENDING
, SUCCEEDED
, or FAILED
state. A payout attempt
that is PENDING
is actively being underwritten.
Create a Payout Link via API
To create a Payout Link
, include:
- The amount of the transaction.
- Any additional URLs (terms of service required).
- Allowed payment methods.
Here's a sample curl request
curl https://finix.sandbox-payments-api.com/payout_links \
-H 'Content-Type: application/json' \
-H 'Finix-Version: 2022-02-01' \
-u US9bhCUqoTxo7V6di8ceb3Td:e704591a-1972-4b41-9884-6a67f5d7cdbb\
-X POST \
-d '{
"allowed_payout_operations": [
"PUSH_TO_CARD"
],
"nickname": "Insurance Claim #2552",
"tags": {
"collectEmail": false,
"collectPhoneNumber": false
},
"items": [
{
"name": "Insurance Payout #2552",
"description": "Car Damage",
"quantity": "1",
"image_details": {
"primary_image_url": "https://upload.wikimedia.org/wikipedia/commons/thumb/8/88/Uninsured_cars_seized_by_police_in_Liverpool.JPG/220px-Uninsured_cars_seized_by_police_in_Liverpool.JPG"
},
"price_details": {
"amount": 100000,
"currency": "USD"
}
}
],
"amount_details": {
"total_amount": 100000,
"currency": "USD"
},
"additional_details": {
"expiration_in_minutes": 10080,
"terms_of_service_url": "https://example.com/terms"
},
"branding": {
"icon": "",
"brand_color": "#0D121A",
"accent_color": "#0B5DBC",
"button_font_color": "#FFFFFF",
"logo": "https://s3-us-west-2.amazonaws.com/payments-dashboard-assets/dashboard.finixpayments.com/2022-04-28-22_56_33-finix-logo-v2.png"
},
"recipient_details": {
"first_name": null,
"last_name": null,
"business_name": null,
"doing_business_as": null,
"email": null
}
}'
Example Response
{
"id" : "payout_link_caKCWTF8wyp784FEN7fF5",
"additional_details" : {
"success_return_url" : null,
"unsuccessful_return_url" : null,
"expired_session_url" : null,
"terms_of_service_url" : "https://example.com/terms",
"expiration_in_minutes" : 10080
},
"allowed_payout_operations" : [ "PUSH_TO_CARD" ],
"amount_details" : {
"total_amount" : 100000,
"currency" : "USD"
},
"application_id" : "AP5Tq3MMxKwHYX7soDncrCQ3",
"branding" : {
"brand_color" : "#0D121A",
"accent_color" : "#0B5DBC",
"logo" : "https://s3-us-west-2.amazonaws.com/payments-dashboard-assets/dashboard.finixpayments.com/2022-04-28-22_56_33-finix-logo-v2.png",
"icon" : "",
"logo_alternative_text" : null,
"button_font_color" : "#FFFFFF"
},
"created_at" : "2024-04-30T22:06:06.92597Z",
"items" : [ {
"name" : "Insurance Payout #2552",
"image_details" : {
"primary_image_url" : "https://upload.wikimedia.org/wikipedia/commons/thumb/8/88/Uninsured_cars_seized_by_police_in_Liverpool.JPG/220px-Uninsured_cars_seized_by_police_in_Liverpool.JPG",
"alternative_image_urls" : [ ]
},
"price_details" : {
"amount" : 100000,
"currency" : "USD"
},
"description" : "Car Damage",
"quantity" : 1
} ],
"link_expires_at" : "2024-05-07T22:06:06.928549Z",
"link_url" : "https://live.sandbox-payments-checkout.com/payout_link?bearer_token=MDE4ZjMxMGItMmM1My03NmVjLTlhYzktZDI3ZmMyYThlNzQzLVBBWU9VVF9MSU5L",
"nickname" : "Insurance Claim #2552",
"recipient_details" : null,
"state" : "ACTIVE",
"tags" : {
"collectPhoneNumber" : "false",
"collectEmail" : "false"
},
"updated_at" : "2024-04-30T22:06:07.007377Z",
"_links" : {
"self" : {
"href" : "https://finix.sandbox-payments-api.com/payout_links/payout_link_caKCWTF8wyp784FEN7fF5"
}
}
}
Successful Payouts
When a recipient successfully receives their payout, the status
of the payout link updates to COMPLETED.
Terms of Service
attention
You must include a URL to your terms of service when creating a payout link.
You must include your terms and services with every payout link you create.