For the complete documentation index, see llms.txt. This page is also available as Markdown.

Operation Detail

Retrieves the detailed report or data file for a specific operation. This is used to fetch the results of a previously executed operation, such as a generated report, export file, or audit log.

Endpoint

GET/v2/report/operations/{cuid}/{opid}

Link

Request

Authentication

An API key is required for authentication. Include it in the Authorization header.

  • Header: Authorization

  • Value: Your API key token (e.g., 123 or a longer JWT token)

Path Parameters

These parameters are required and are part of the endpoint URL.

Parameter
Type
Description
Required
Example

cuid

string

The unique identifier for the customer.

Yes

cust_abc123def

opid

string

The unique identifier for the operation.

Yes

op_789xyz

Headers

Key
Value
Required

Authorization

Bearer <JWT>

Yes

Accept

application/json

Yes


Response (200 OK)

Returns the operation's data file and its name. The data field typically contains a base64-encoded file (e.g., PDF, CSV).

Response Fields

Field
Type
Description
Example

data

string

The file data, often base64-encoded. You will need to decode this to get the original file.

"aGVsbG8gd29ybGQ="

name

string

The name of the file. This usually includes the file extension.

"transaction_report.pdf"

Example Response:


Examples

Request (cURL)

This example shows how to call the API to get the details for a specific operation.

🔑 Important: Replace cust_abc123def and op_789xyz with the actual cuid and opid values you received from a previous API call (like the Operations List).


Error Responses

  1. 404 Not Found:

    This happens if the provided cuid or opid is incorrect.

  2. 401 Unauthorized:

    This happens if the API key is missing, invalid, or expired.


Notes

  • Decoding Data: The data field is usually a Base64-encoded string. You will need to decode it on your end to save or use the actual file.

  • File Format: The format of the file is indicated by the extension in the name field (e.g., .pdf, .csv, .xlsx).

  • Usage: This endpoint is typically called after getting a list of available operations from the GET /v2/report/operations endpoint, which provides the necessary opid values.

Common Use Cases:

  • Downloading a generated financial report.

  • Fetching a receipt or confirmation document for a specific transaction.

  • Retrieving a log file for auditing purposes.

Request sample

Response sample

Last updated