Jump to

• Request
• Response

Download B2B Business Message Payload

get

/ic/api/b2b/v1/monitoring/businessmessages/{id}/payload/download

Downloads the payload file of the B2B business message using the message identifier.

Note: Tracking information is asynchronously persisted to improve system throughput, and hence B2B Monitoring APIs may intermittently return inconsistent results. If a business use case demands consistent monitoring results, the user can implement a software design that uses a retry mechanism till the API returns consistent results.

Request

Path Parameters

• id(required): string
  Message identifier.

Query Parameters

• payloadId: string
  Payload identifier.
• type: string
  Message payload type.

  Default Value: native

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/octet-stream

200 Response

Successful operation

Body ()

Root Schema : Object

Type: object

400 Response

Malformed parameters

404 Response

Payload not found

500 Response

Server error

Back to Top