Debit all customers in a given on-demand debit recurring payment plan

post

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

Introduction

This endpoint allows you to debit all customers that are subscribed to 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

planId

string

required

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.

amount

number

required

A non-negative amount you wish to debit the plan subscribers in your home currency. If the subscribers are international clients, 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.

Headers

Client-Id

string

Unique identifier of Child Account (required only for Partner).

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