API Reference
Log In

Debit a single customer from a specific on-demand debit recurring payment plan.


This endpoint allows you to debit a single customer through either an on-demand debit or a recurring payment plan. Below you will find the required data to submit this request.

Data Requirements

Provide the following data requirements when sending a POST request to the On-Demand API endpoint.

Additional Header parameter:

Parameter Required? Description Type
Client-Id No Unique identifier of Child Account (required only for Partner). See Authentication Page to learn more. String

The body of the request should contain a JSON object with the the following information:

Parameter Required? Description Type
paymentAmount Yes The amount you wish to debit the plan subscriber. A non-negative amount in your home currency to debit from the customer. If the subscriber is an international client, borderless™ auto-detects their currency and debits the equivalent amount of the plan’s amount with better exchange rates than most banks or PayPal. The funds will be debited in their home currency and delivered to your bank account in your home currency. Number
paymentDescription Yes A description of the payment being sent with a maximum length of 60 characters, including spaces. This will be shown to the recipient when the transaction completes. String
planId Yes The borderless™ planId denoting the plan which this customer is a member of. This is available in the borderless™ dashboard when you click, 'View Plan Details'. String
customerHandle Yes Account @handle of the customer you would like to debit, without the “@” symbol. Read more about borderless™ @handles. String
Click Try It! to start a request and see the response here!