Appendix

White-Label Authentication

All API calls need to be authenticated, which is done by adding a Basic header that includes your API Username and API Password converted to Base64 (instructions on how to find your creds are here). In Postman or Insomnia, you can easily add these as “Username” and “Password” under “Basic” headers or “Basic Auth,” respectively (they are automatically converted to Base64). You can also just use an online Base64 converter.

White-Label Refunds

Refunding part or all of a plan is achieved by calling the Refund API and passing in the plan number along with the desired refund amount. Note that the default refund strategy is FutureInstallmentsFirst.
Refund cURL example

White-Label Cancellations

Cancel a plan by passing the plan number to the Cancel API. You will need specify how to handle refunds (either NoRefunds, meaning the plan won’t be refunded at all, or OnlyIfAFullRefundIsPossible, meaning that the plan will be cancelled only if full refunds for all past installments have been completed.
Cancel cURL example

White-Label Webhooks

To receive a webhook showing that your plan was successfully finalized, you can add your desired endpoint to the the EventsEndpoints object when you call Initiate in Step 2.
“EventsEndpoints”: {
“CreateSucceeded”: “https://www.async-success.com/”
},
Export as PDF
Copy link
On this page
White-Label Authentication
White-Label Refunds
White-Label Cancellations
White-Label Webhooks