txn.Begin

This method is supported by Operations starting from version 2.6.3.

This method begins the transaction. Use the txn.Commit method to commit the transaction or use the txn.Rollback method to rollback the transaction.

The method has the following input parameters:

Name

Type

Short Description

[txn_id]

string

Transaction ID. This is optional parameter. If it is omitted, parameter is generated by Operations.

[timeout]

int

Defines transaction timeout (in seconds). This is optional parameter. Timeout is unlimited by default.

[request_id]

string

Request ID. It is used to track the overall status of tasks scheduled by the transaction, if specified. Use the pem.getRequestStatus method to obtain the overall status of tasks scheduled after transaction commit.

The method has the following output parameters:

Name

Type

Short Description

txn_id

string

Transaction ID.

Important: If you want to call this method with no parameters specified, you should do the call with an empty parameters structure, like in the example below:

<?xml version='1.0'?>
<methodCall>
	<methodName>txn.Begin</methodName>

<!-- mandatory part -->

   <params>
	<param>
	    <value>
		<struct>
		</struct>
	    </value>
	</param>
   </params>
</methodCall>

Starting from version 7.0 of CloudBlue Commerce, the parameters structure is mandatory for this method call. Omitting it will result in error.

See also:

Using Transactions diagram