Integration Checklist

Before directly integrate to payments API, Please make sure to read and learn the pre-requisite checklist.

  • General Product Knowledge. Please read the general product flow here
  • Get your API private key for basic API authentication.
    Basic authentication is a simple authentication scheme built into the HTTP protocol. To use it, send your HTTP requests with an Authorization header that contains the word Basic followed by a space and a base64-encoded. Learn more about API keys here.
  • Set up webhook / callback.
    Xendit will send your web application HTTPS requests asynchronously after certain events occur. Please refer to this documentation for a better understanding of webhook, here. To set up your endpoint URL, you may able to go to the Xendit dashboard, then click Setting > Developer Setting > Callbacks. After you are redirected to the Callback setup page, then choose the webhook event you want to listen to.
  • Postman collection. to help you better understand the API flow and let you test the integration easily. Please make sure to choose New Payments API. Please make sure to use the product as New Payments API > Product that you will integrate Download here
  • Plan your reconciliation method. to handle unexpected failure during the API call, you may need to retry the transaction using the unique identifier you will give to Xendit in the request. In payment API, we recommend you to pass the reference_id parameter as your unique identifier. Xendit will provide this reference_id that you send in the API response or callback for the reconciliation propose. Learn more here

Last Updated on 2023-06-02