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

post

https://prod.api.getborderless.com/customerOnDemandDebit

Introduction

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

paymentAmount

number

required

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.

paymentDescription

string

required

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.

planId

string

required

The borderless™ planId denoting the plan which you want to invite a customer to subscribe to. This is available in the borderless™ dashboard when you click, 'View Plan Details'.

customerHandle

string

required

Account @handle of the customer you would like to debit, without the “@” symbol.

Responses

404

Server Error

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Error

401Authentication Error