...
Opens a transaction as a platform-managed user. The returned TransactionMessage contains the transaction information as well as user status. It is possible to see which participants have opened or signed the transaction, provided that the calling application is permitted to view that information.
HTTP Method | URI Scheme |
---|---|
PUT | /server/managed-user/transaction/open |
Parameters
Type | Name | Description | Qualification | Schema |
---|---|---|---|---|
Body | request | Request body parameters, see schema for details. | Required |
Responses
HTTP Code | Common messages | Description | Schema |
---|---|---|---|
200 |
Information about the opened transaction. | |||
400 | The application with the specified key could not be found | String | |
Input not valid: Participant can not be null. | This error message is returned if the 'user' parameter of ManagedUserTransactionRequest is missing. | String | |
Input not valid: Transaction can not be empty | This error message is returned if the 'transaction' parameter of ManagedUserTransactionRequest is missing or is empty. | String | |
An error has occurred | This error message is returned if the transaction data of ManagedUserTransactionRequest is not in the correct format. | String | |
Input not valid: Participant can not be of unknown type: null | This error message is returned if
| String | |
Input not valid: Participant corporateId can not be null for corporate or server user. | String | ||
Input not valid: Participant applicationAccessId can not be null for private or corporate user. | String | ||
Input not valid: Participant privateId can not be null for private or corporate user. | String | ||
Unknow error | This error message is returned if a wrong 'type' is specified for User. For example, a CORPORATE type is mentioned as SERVER. | String | |
500 | An unexpected error occurred: JSON parse error: <%1> | This error message can be returned if one or more parameters are of the wrong type. | String |
An unexpected error occurred: Type definition error: <%1> | This error message can be returned if one or more parameters are of the wrong type. | String |
Security
Type | Name |
---|---|
apiKey |