Activation
Getting started
Set up your account
To use our Disbursement APIs, register for a Xendit account. You can start testing our APIs immediately in the development environment.
When you are ready to process live transactions, click on “Activate Account” on the Dashboard and follow the KYC instructions to go live. After filling in the KYC information, our team will reach you to arrange to sign our service agreement. At that point, go to Settings > Disbursements to enable disbursements for your account.
Retrieve your API Key
We provide unique API keys for Development and Production environments. You can retrieve these from your Dashboard. Your API keys should be kept private, so do not share your secret API keys.
To successfully authenticate with Xendit’s API, you must append a colon and Base 64 encode the API key. All API requests should be made over HTTPS instead of HTTP (all calls made over plain HTTP will fail).
Set your callback URL and other settings
Before trying out our API, please set your callback URL via the Dashboard. Put your callback URL in the field and click Test to verify the URL. Once your URL is verified, you can click Save to proceed.
Please also set up the following:
- Default description: We require a description of all your disbursements. You can set the default in your Dashboard. You can also set custom descriptions for each disbursement when you create the disbursement.
- Disbursement receipt sender: When funds have been successfully disbursed, we can send out a receipt via email on your behalf, so your recipient is notified of the incoming funds. To use this feature, including the destination email addresses in your disbursement request. You can customize the email sender and email footer in your Dashboard.
Start testing!
You may test our APIs by sending requests in the development environment--You will automatically get IDR 1,000,000,000 in your development account balance for testing. Requests made in the development environment will not hit the banking networks and will not cost you anything.
To simulate various testing scenarios, follow our Testing instructions.
Topping up your Balance
Your balance refers to the stored value in your Xendit account which can be sent out in disbursements or withdrawn.
Before you send any live disbursements, you will first have to top up to your account balance. We hold these funds securely on your behalf until you give us instructions to disburse.
You can top up by transferring funds to Xendit's bank accounts. You can see Xendit's bank account details for the transfer in your Dashboard. See Topup instructions.
Last Updated on 2023-05-24