APappian
Outbound Messages

Send an outbound Swift message

Receives a structured Appian data object, converts it to a valid Swift MT or MX message, validates the message, and sends it to the configured upstream channel. The content field contains the message-type-specific payload structured as JSON.

post/webapi/outbound-messages

Request

Request body

swiftVersion'2025' | '2026'

The Swift standards version to use for message generation and validation. Determines which Prowide library version is applied.

sourcestring required

Identifier of the system sending the outbound request.

destinationstring

The target system or channel for the outbound message. This is a free-form string; any value can be passed through this field.

destinationFieldsobject[]

Additional metadata key-value pairs for the destination.

ignoreValidationboolean

If true, skips Swift message validation before sending. Use with caution — invalid messages may be rejected by the Swift network.

validateBicboolean

Whether to validate BIC codes in the outbound message against the BIC reference database.

Example request

{
  "content": {
    "messageType": "camt.057.001.06"
  },
  "swiftVersion": "2025",
  "source": "payment-investigation-app",
  "destination": "swift-network"
}

Response

Message created, validated, and sent successfully.

messageIdstring uuid

The unique identifier assigned to the outbound message.

status'RCVD' | 'ERR-001' | 'ERR-002'

The processing status of the outbound message.

errorstring nullable

Error message, or null on success.

contentobject nullable

Additional content returned by the service, or null.

Example response

{
  "status": "RCVD"
}

Changes

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