Download receipt for a transaction
Method: GET
Path: /api/file/receipt/{transactionId}
Downloads the receipt for a completed transaction (Status=30). The receipt contains information about the signing process and serves as proof of the completed transaction.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| transactionId | path | string | Yes | The transaction ID for which to download the receipt |
Responses
200
Receipt file successfully retrieved
Content-Type: application/pdf
Type: string
401
Authorization denied - user not authorized to access this transaction
Content-Type: application/json
Schema: ErrorResponse
Properties
| Name | Type | Description |
|---|---|---|
| type | String | A URI reference identifying the problem type. This property is always present in RFC 7807 responses. |
| title | String | A short, human-readable summary of the problem |
| detail | String | A human-readable explanation specific to this occurrence of the problem |
| status | Integer | The HTTP status code |
| instance | String | A URI reference that identifies the specific occurrence of the problem |
| Message | String | Deprecated (Legacy Format Only): Contains the error message in the old response format. This property appears alone in legacy error responses and is mutually exclusive with the RFC 7807 properties above. Will be phased out as we complete our transition to RFC 7807. |
Example:
404
Receipt not found
Content-Type: application/json
Schema: ErrorResponse
Properties
| Name | Type | Description |
|---|---|---|
| type | String | A URI reference identifying the problem type. This property is always present in RFC 7807 responses. |
| title | String | A short, human-readable summary of the problem |
| detail | String | A human-readable explanation specific to this occurrence of the problem |
| status | Integer | The HTTP status code |
| instance | String | A URI reference that identifies the specific occurrence of the problem |
| Message | String | Deprecated (Legacy Format Only): Contains the error message in the old response format. This property appears alone in legacy error responses and is mutually exclusive with the RFC 7807 properties above. Will be phased out as we complete our transition to RFC 7807. |
Example:
Content-Type: text/plain
Type: string
Example:
406
Not Acceptable - unsupported Accept header
Content-Type: application/json
Schema: ErrorResponse
Properties
| Name | Type | Description |
|---|---|---|
| type | String | A URI reference identifying the problem type. This property is always present in RFC 7807 responses. |
| title | String | A short, human-readable summary of the problem |
| detail | String | A human-readable explanation specific to this occurrence of the problem |
| status | Integer | The HTTP status code |
| instance | String | A URI reference that identifies the specific occurrence of the problem |
| Message | String | Deprecated (Legacy Format Only): Contains the error message in the old response format. This property appears alone in legacy error responses and is mutually exclusive with the RFC 7807 properties above. Will be phased out as we complete our transition to RFC 7807. |
Example:
410
Gone - receipt is no longer available (archived or deleted)
Content-Type: application/json
Schema: ErrorResponse
Properties
| Name | Type | Description |
|---|---|---|
| type | String | A URI reference identifying the problem type. This property is always present in RFC 7807 responses. |
| title | String | A short, human-readable summary of the problem |
| detail | String | A human-readable explanation specific to this occurrence of the problem |
| status | Integer | The HTTP status code |
| instance | String | A URI reference that identifies the specific occurrence of the problem |
| Message | String | Deprecated (Legacy Format Only): Contains the error message in the old response format. This property appears alone in legacy error responses and is mutually exclusive with the RFC 7807 properties above. Will be phased out as we complete our transition to RFC 7807. |
Example:
500
Internal server error
Content-Type: application/json
Schema: ErrorResponse
Properties
| Name | Type | Description |
|---|---|---|
| type | String | A URI reference identifying the problem type. This property is always present in RFC 7807 responses. |
| title | String | A short, human-readable summary of the problem |
| detail | String | A human-readable explanation specific to this occurrence of the problem |
| status | Integer | The HTTP status code |
| instance | String | A URI reference that identifies the specific occurrence of the problem |
| Message | String | Deprecated (Legacy Format Only): Contains the error message in the old response format. This property appears alone in legacy error responses and is mutually exclusive with the RFC 7807 properties above. Will be phased out as we complete our transition to RFC 7807. |
Example: