Create Recurring External Card Pull Transfer (GQL)

post

https://api.cloud.mbanq.com/graphql ( For Recurring External Card Pull Transfer)

Note: All the payment API's have the endpoint: /graphql

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

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

Body Params

Following are the details on the GraphQL fields :

Parameter	Description	Mandatory	Data Type	Example
startDate	The date when the recurring payment should start.	Yes	String	`30 April 2025`
paymentTimeType	Defines how the recurring payments are scheduled (e.g., INTERVAL-based).	Yes	String	`INTERVAL`
interval	The number of units (based on frequency) between each payment.	Yes	Integer	`1`
frequency	The time unit used for recurrence (e.g., DAYS, MONTHS, YEARS).	Yes	String	`MONTHS`
amount	The amount to be pulled on each recurring transaction.	Yes	Decimal	`33`
recipientId	The ID of the recipient from whom funds will be pulled.	Yes	Integer	`42`
savingsAccountId	The ID of the savings account to which the funds will be credited.	Yes	Integer	`644`
transferType	The type of transfer operation (e.g., DEBIT or CREDIT).	Yes	String	`DEBIT`
dateFormat	Format in which the `startDate` is provided.	Yes	String	`dd MMMM yyyy`
locale	Locale used for formatting dates and numbers.	Yes	String	`en`
active	Indicates whether the recurring payment setup is currently active.	Yes	Boolean	`true`

Headers

tenantId

string

required

Defaults to z01j3e71zd6zkq908vyf5861a8

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

Response

Language

Loading…

Response

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

application/json

200Successful response