Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
Message forward

Forward message

Forward a message that has been generated by your own system to your partner bank, CSM, or Swift network. The message is sent as is by Mambu Payments (formerly Numeral).

Replaces POST /message_forward/connected_accounts/... (now deprecated) with a body-based shape that additionally accepts an optional swift block for Swift Business Connect overrides.

Per Swift channel, the override fields apply as follows:

Fieldswift_finswift_fileactswift (InterAct)
swift.receiver_bic✅
swift.receiver_dn✅✅
swift.service✅✅
swift.message_type✅✅✅
swift.message_reference✅✅✅
post/message_forward

Request body

connected_account_idstring uuid required

The connected account to forward this message from.

bank_service'bacs_direct_credit' | 'bacs_direct_debit' | 'chaps' | 'end_of_day_statements' | 'fps' | 'intra_day_statements' | 'sct' | 'sct_inst' | 'sdd' | 'swift' | 'swift_fin' | 'swift_fileact' required

The bank service to use. Must be enabled on the connected account.

file_namestring required

File name. Between 3 and 140 characters.

contentstring byte required

The file content, base64-encoded.

Example request

{
  "swift": {
    "receiver_bic": "SOMEBIC0XXX",
    "receiver_dn": "ou=mfunds,o=swhqbebb,o=swift",
    "service": "swift.generic.fa!p",
    "message_type": "pacs.008.001.08",
    "message_reference": "ABCD12345"
  }
}

Response

Successfully forwarded a message.

idstring required

The UUID of the file.

object'file' required

Label used to identify this kind of object.

connected_account_idstring uuid

The ID of the connected account used to send or receive the file.

connected_account_idsstring[] required

The IDs of the connected accounts used to send the file. Contains only one entry.

direction'outgoing' required

The transfer direction for the file_id: - outgoing for files sent or to be sent to the bank.

category'forwarded_message' required

The category of the file.

formatstring required

The format of the file.

filenamestring required

The name of the file.

sizeinteger required

The size of the file, expressed in bytes.

summaryobject required

A summary of the file, depending on its content.

status'created' | 'approved' | 'canceled' | 'sent' required
status_detailsstring required

The details of the status of this file, such as the rejection reason for instance.

created_atstring date-time required

The UTC timestamp of the creation of the file.

Example response

{
  "id": "3ad331b9-12b2-48fd-ad35-203fe8b5e78e",
  "object": "file",
  "connected_account_ids": [
    "6669205e-e306-4b44-bf40-0475899eeb60"
  ],
  "direction": "outgoing",
  "format": "custom.format",
  "filename": "SFPP30X40.3ad331b9-12b2-48fd-ad35-203fe8b5e78e.1659349967",
  "size": 2234,
  "bank_data": {
    "message_ids": [
      "211012231391882"
    ]
  },
  "status_details": "generated on 2022-08-01",
  "created_at": "2022-08-01T06:00:05Z"
}