English
API ReferenceSign In

Quick Start

Last updated 03/12/2021

This page will guide you on how to use Xendit APIs easily

xendit-api-quick-start

Register A Xendit Account

Register here if you do not have an account Login to Xendit Dashboard

Generate API Key

Only user with Admin or Manage Tech Settings permission can generate API key
  1. Go to API keys settings in Xendit Dashboard
  2. In Secret keys in API Keys section, click Generate secret key to generate your secret key
  3. A pop-up will be prompted to configure your API key name and permission.
  4. Click Generate Key
  5. Your secret API key will be shown in the pop-up. You can Copy or Download the key.
    The key will only be displayed once in this pop up and will not be able to be viewed again after the pop up has been closed.
  6. You can generate, edit, or delete API key name and permissions when you need to
We highly recommended you to select strict API key permission. Generate unique API key for different product or don't select permission for product you are not planning to use yet

Create API Request

Use our Postman collection to explore Xendit APIs. Simply select any API you're interested in, attach the API key in header, and send the request

Run in Postman

Setup Webhook/Callback

For some of our products, we'll send a webhook/callback after we have processed your requests. Webhook/Callback setup can be done via these steps:

  1. Set up your server to listen to our callback request. You can use a tool like ngrok to make your endpoint available for receiving callback
  2. Navigate to Callback settings in Xendit Dashboard
  3. Attach your server's URL in the input box of the product you are going to use. Click Save and Test and a dummy event will be sent to the URL
  4. Validate Xendit as legitimate webhook sender via x-callback-token header. Find your x-callback-token in Callback verification token section in Callback settings

See Callback page for more information about our callback feature

Setup IP Whitelist

Block unauthorised request from unrecognised IP Address by whiteliting your server IP Address

  1. Navigate to IP Whitelist settings in Xendit Dashboard
  2. In IP Whitelists section, Add IP Address to whitelist your server IPs. You can find your IP address by using What's My IP

Going Live Checklists

See our going-live checklists to make sure your integration is completed