Create Internal Transfer

post

https://api.cloud.mbanq.com/v1/payments (for Internal Transfer)

Use this API for initiating an outgoing internal transfer between two accounts within the platform.

** Behaviour **: A successful response from this API indicates that the transfer was successfully executed.

** Flow of Funds **: Originator to Recipient only (PaymentType : CREDIT).

** Settlement Timeline **: Funds are transferred in real-time from the Originator to the Recipient account.

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

Body Params

paymentType

string

enum

required

Defaults to CREDIT

Specifies the type of payment. Example: CREDIT

Allowed:

paymentRail

string

enum

required

Defaults to INTERNAL

Indicates the payment network used. Example: INTERNAL

Allowed:

amount

number

required

Defaults to 99.99

The payment amount. BigDecimal; integer part max 12 digits, fraction part max 24 digits.

originator

object

required

recipient

object

required

correlationId

string

Unique identifier for tracking the transaction. Maximum length: 100 characters.

reference

string

length ≤ 140

Optional reference or description for the transaction. Example: transferring to amy.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

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

application/json

200Amount Transferred Successfully.

400The request fails if the required parameters are not given.E.g. creditor parameter is not given.

401Authentication credentials were missing or incorrect.

403The authenticated user does not have permission to initiate transfers.

404The request fails if referenced resources (originator account or recipient) are not found.