Creating Payout Links
Creating a payout link is simple and easy. You can choose to create it via your dashboard, or via API. All of your payout links will be displayed on the dashboard along with their status and details.
Payout Link Rules
Before you create a payout link, there are some rules you need to understand:
- Once you created a payout link, you can’t change any details of the payout. Should you wish to cancel the payout link, you can do so by clicking “Void” in the said payout link page from Xendit Dashboard or hitting our Void Payout API.
- Payout link limit is 3 days. If there is no claim in 3 days after the payout creation, the payout link will be expired.
- Your payout link will be marked as failed if there are 3 wrong secret password input at the point of payout claim.
Create Payout Links
You can create payout links via Xendit Dashboard or API depending on what might suit your business needs. Below is the overview you may want to consider when choosing between the two options:
| Payout Link Creation Platform | Benefits | Trade-offs |
|---|---|---|
| Dashboard | - Doesn't require technical integration - Create payout links anywhere and anytime as long as you have access to Xendit dashboard with edit permission - Step-by-step payout link creation is easy to understand | Payout link creation is done manually (can't be automated) |
| API | - Payout link creation is automated via API - Create payout links within seconds - User Interface can be customized based on your business needs | Requires developer resources for technical integration |
Create Payout Links via Dashboard
To create an payout link via dashboard, you Account User should have at least EDIT permission. Follow these steps to create a payout link via Xendit dashboard:
- Login to your Xendit dashboard
- Go to Send Payments > Payouts
- Click "Create Payout Link" to create a payout and use the information below as your guide
| Field | What to Fill |
|---|---|
| External ID | Unique identifier for your created Payout Link. Alphanumeric characters supported (no space allowed). Please ensure your external ID is unique to allow easy reconciliation according to your usecase, example: HOUSE.AP/INV/XXV/341293TPR0004XJEDBDIEFDJIAGDY |
| Amount | The total amount of money you want to disburse |
| Email address of the payout link recipient. We will send them an email with the password for them to claim the payout |
After you create a payout link, an email will be generated and sent to the recipient's email. This email contains instructions, a password, and a link to the payout UI.
Create Payout Links via API
Follow these steps to create an payout link via API:
- Follow the instruction in Xendit API Reference on Create Payout Link section to start creating your payout via API
- Setup your Disbursement Callback URL in Xendit Dashboard for "Disbursement sent"
Example of Create payout link via API
Testing Payout Links
Test payout links via amount by following these simple steps:
- Create a payout link and fill in the amount (via Dashboard or API)
- Claim your payout in the payout link and input the secret password
- Go to your Payout Link tab in Xendit dashboard
- Wait 10 minutes and Payout status will be changed to “Completed”
Please note that the testing will only trigger after you have inputted the secret passkey from your email in the payout link. You may also find the testing scenarios based on the Disbursements Testing simulation.
Payout Link Statuses
To enhance your experience, Xendit Payout Link has its own status that will help you to easily identify which payouts are already completed, claimed, or failed/voided. These are the possible statuses payout links can have:
| Status | Description |
|---|---|
| Pending | Payout links has been successfully created and payout link has been sent to the recipient email. At this point, the disbursement has not been initiated |
| Claimed | The recipient has successfully claimed the payout links and disbursement is initiated |
| Completed | Funds successfully disbursed to the recipient bank account |
| Failed | The payout links has failed. Reasons can vary from expiring without being claimed, locking due to password failures, to an issue with the bank disbursement |
| Voided | The payout links has been voided. This issue is raised because the payout is expired or manually voided by hitting the void endpoint |
Last Updated on 2024-07-01