Get Sandbox Keys
API Reference

Create Credit Auto-Pay Standing Instruction

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

Use this API to create a new standing instruction for automatic credit account bill payments.

The standing instruction will be set up to automatically deduct the minimum due amount or the full statement balance from either an internal account or external account using ACH on the due date.
This ensures timely payments and helps avoid late fees and interest charges.

Supported Account Types:

  • Internal Account: Use fromAccountId when isAccountExternal is false
  • External ACH Account: Use fromAccountNumber and fromAccountRoutingNumber when isAccountExternal is true

Behaviour : A successful response from this API means the auto-pay standing instruction is created successfully for the client's credit account.

Body Params

Request body for creating a credit auto-pay standing instruction. Choose the appropriate payload based on your account type:

For Internal Account Transfers:
Use CreateCreditAutoPayStandingInstructionInternalRequest when isAccountExternal is false

For External ACH Account Transfers:
Use CreateCreditAutoPayStandingInstructionExternalRequest when isAccountExternal is true

Request payload for creating a credit auto-pay standing instruction using an internal account as the source.
This payload is used when isAccountExternal is set to false and the payment source is an internal account within the system.

string
required
Defaults to Auto Pay

Specify a recognizable name for this auto-pay instruction.
Example: Auto Pay

integer
enum
required
Defaults to 5

The type of transfer for the standing instruction.
Constant value: 5 - Credit Card Auto Pay

Allowed:
integer
enum
required
Defaults to 2

The priority of the standing instruction.

  • 1 - URGENT
  • 2 - HIGH
  • 3 - MEDIUM
  • 4 - LOW
Allowed:
integer
enum
required
Defaults to 1

The status of the standing instruction.

  • 0 - INVALID
  • 1 - ACTIVE
  • 2 - DISABLED
  • 3 - DELETED
Allowed:
integer
required
Defaults to 1

The office ID from which the payment is initiated.
Example: 1

integer
required
Defaults to 15632

The client ID from which the payment will be deducted.
Example: 15632

integer
enum
required
Defaults to 2

The account type from which the payment will be deducted.
Constant value: 2 - SAVINGS

Allowed:
integer
required
Defaults to 14231

The account ID from which the payment will be deducted.
Required for internal account transfers.
Example: 14231

integer
required
Defaults to 1

The office ID where the payment will be credited.
Example: 1

integer
required
Defaults to 15632

The client ID to which the payment will be credited.
Example: 15632

integer
enum
required
Defaults to 3

The account type to which the payment will be credited.
Constant value: 3 - CREDIT

Allowed:
integer
required
Defaults to 1885

The account ID to which the payment will be credited.
Example: 1885

integer
enum
required
Defaults to 3

The type of instruction for the auto-pay setup.

  • 3 - MIN_DUE
  • 4 - STATEMENT_BALANCE
Allowed:
string
required
Defaults to en

The locale for formatting date and numbers.
Example: en

Headers
string
required

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

Response

Updated 3 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 3 months ago

Did this page help you?