Inbound Messages

Receive an inbound Swift message

Receives a raw Swift MT or MX message for validation, parsing, and conversion into a structured Appian data object. The message is processed asynchronously. Use the returned messageId to poll for processing status.

post/webapi/inbound-messages

Request

Request body

contentstring required

The raw Swift message content. For MT messages, this is the full FIN message string including all blocks (1-5). For MX messages, this is the XML content.

timestampstring date-time required

ISO 8601 timestamp of when the message was sent by the source system.

sourcestring required

Identifier of the source system sending the message.

sourceFieldsobject[] required

Additional metadata key-value pairs from the source system. Must not be empty.

validateBicboolean

Whether to validate BIC codes in the message against the BIC reference database. Set to false if BIC validation is not required or BIC data has not been ingested.

Example request

{
  "content": "{1:F01BANKUS33XXXX...}{4:\\n:20:REF123\\n...}",
  "timestamp": "2026-05-22T22:51:00.000Z",
  "source": "IBM-MQ-Gateway"
}

Response

Message received and queued for processing.

messageIdstring uuid

The unique identifier assigned to the received message.

status'INBD_STTS_RCVD' | 'INBD_STTS_ERR-001' | 'INBD_STTS_ERR-004'

The status of the message upon receipt. Possible values:

  • INBD_STTS_RCVD: Message received successfully.
  • INBD_STTS_ERR-001: Error persisting message or starting processing.
  • INBD_STTS_ERR-004: Request body was empty.

Example response

{
  "messageId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "INBD_STTS_RCVD"
}

Changes

No recorded changes to this operation across all 1 revision of this API.