Create FX Pay Transfer

post

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

Use this API for initiating an FX Pay Transfer using the SWIFT network. You need to specify the account details of both the originator and recipient. An outgoing credit transaction can be initiated using this Payment Rail.

Please checkout the page at FX PAY to understand more about FX PAY Payment Rail.

During the lifecycle of a transfer, its status may undergo changes. Refer to the Transfer Status page at Transfer Status for detailed descriptions associated with each status.

The address information is available at Address Info

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

Body Params

paymentType

string

enum

required

Defaults to CREDIT

Specifying the type of payment during the transfer. For pull payment, CREDIT is the paymentType.
Example: CREDIT

Allowed:

paymentRail

string

enum

required

Defaults to FXPAY

The FXPAY would be the default payment rail for pull transfer.
Example: FXPAY

Allowed:

amount

number

required

^(?:\d{1,12}(?:\.\d{0,24})?|\.\d{1,24})$

Defaults to 10

The amount to be transferred in USD.
Pattern: Maximum amount is defined by the transfer limits configured.
Example: 10

originator

object

required

The details of the originator for the transfer.

recipient

object

required

The recipient for the transfer.

paymentRailMetaData

object

required

fxPayCreditorIdentifier

string

Unique identifier for the FX Pay creditor, used to reference the creditor entity involved in the transaction.
Example: FXPAY://12345/987/1234567890

reference

string

length ≤ 140

Defaults to transferring to any

The customer/originator reference for the transfer. It will be shown in the customer statement.
Example: transferring to any

correlationId

string

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

forFurtherCredit

string

length ≤ 195

The reference for future credit.
Example: MV VYSYA BANK ACC NUM1234656

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

200The FX Pay Transfer is created 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.