API Reference

Create Recurring Payment for External Card Pull

post
https://api.cloud.mbanq.com/v1/recurringpayments

Use this API to create a recurring payment schedule that pulls funds from an external card.

This setup is ideal for automating periodic debits from an acquired (external) card to a specified savings account.

To initiate the recurring payment, you must provide the externalCardId associated with the recipient.

Please checkout the page at External/Acquired Cards to understand more about this Payment Rail.

Please refer to this API Add an Acquired Card on how to generate the card cardId

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
Defaults to Recurring External Card Pull

The name or title given to the recurring external card pull setup.
Example: Recurring External Card Pull

integer
required
Defaults to 696

Unique identifier of the recipient from whom the card pull payment will be made.
This is typically generated when the recipient is created.
Example: 696

integer
required
Defaults to 16415

The identifier of the savings account where the pulled funds will be credited.
Example: 16415

double
required
Defaults to 100

The amount of money to be pulled in each recurring payment cycle.
Example: 100

string
required
Defaults to INTERVAL

Defines how the payment timing is controlled. Supported value is INTERVAL for interval-based recurring payments.
Supported values are: INTERVAL, SPECIFIC_DATE
Example: INTERVAL

string
required
Defaults to MONTHS

Frequency unit for the recurring payment interval.
Supported values: DAYS, WEEKS, MONTHS, YEARS.
Example: MONTHS

integer
required
Defaults to 1

The number of units (as per frequency) between each recurring payment.
Example: 1 (every 1 month)

date
required

The date on which the recurring payment should begin.
Must follow the format specified in dateFormat.
Example: 28 May 2025

string
required

The format in which the startDate is provided.
Example: dd MMMM yyyy (e.g., 28 May 2025)

specificDates
array of objects

A list of specific payment dates. Multiple entries are allowed.

Each entry is a map that must include:

  • date: the specific payment date
  • dateFormat: the format used for that specific date

Used only when paymentTimeType = SPECIFIC_DATE.

Example:

[
  { "date": "15 June 2025", "dateFormat": "dd MMMM yyyy" },
  { "date": "01-07-2025", "dateFormat": "dd-MM-yyyy" }
]
specificDates
date

The date on which the recurring payment schedule should stop.
Optional field. Must follow the format specified in dateFormat.
Example: 28 May 2026

string

Indicates the type of transfer. For pulling funds from external card, this should be DEBIT.
Example: DEBIT

boolean

Indicates whether the recurring payment setup is currently active.
If set to true, the schedule is active and payments will be triggered as defined.
Example: true

string

The locale used to interpret dates and numbers. Common value is en for English.
Example: en

Headers
string
required
Defaults to z01j3e71zd6zkq908vyf5861a8

The ID of your banking instance visible in the MBANQ Console.

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?