home > support > API > Marketplace API > Complete Spreedly Transaction
Complete a Spreedly transaction
Part of TourCMS integration with Spreedly for processing tractions with 3D Secure 2.
Complete a "pending" 3D Secure 2 transaction created via the Create Spreedly Payment endpoint.
If you are implementing 3D Secure 2 using TourCMS Spreedly integration you should call this endpoint when the Spreedly documentation advises you to call the Spreedly "Complete" endpoint rather than calling Spreedly directly.
Differs from the Spreedly endpoint in that repeated or subsequent calls will return the latest status of the transaction rather than an error message.
Learn more about TourCMS Spreedly integration
REST info
| Endpoint | /c/booking/gatewaytransaction/spreedlycomplete |
| Formats | XML |
| Example | URL: /c/booking/gatewaytransaction/spreedlycomplete.xml?id=49aa3e94-79ce-4912-acc3-9c26b75950e3 |
| Verb | POST |
Code samples
PHP examples use the PHP Client Library with SimpleXML
Description
object spreedly_complete_payment ( string $transaction_id, int $channel )
Parameters
- $transaction_id
- String containing the TourCMS transaction ID
- $channel
- Channel ID as per TourCMS API settings page
Example
// Set your Channel ID, as per the TourCMS API settings page
$channel = 3;
// Provide the transaction ID obtained from TourCMS Spreedly Create Payment
$transaction_id = '49aa3e94-79ce-4912-acc3-9c26b75950e3';
// Call TourCMS API, attempting to complete the transaction
$result = $tourcms->spreedly_complete_payment($transaction_id, $channel);
// No documentation currently available// No documentation currently available// No documentation currently availableLooking for sample code in a different language? TourCMS and community provided API libraries
Querystring parameters
| Param | Notes |
|---|---|
| transaction_id | String, TourCMS ID for this transaction, e.g. 49aa-3e94 |
Response fields
| XML Node | Notes | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| request | Confirmation of the request that you sent | ||||||||||||||||||||||||||
| error | An error response of "OK" indicates a transaction has succeeded, otherwise an error will be displayed indicating the issue Check the //transaction/state and //transaction/required_action to decide how to continue. |
||||||||||||||||||||||||||
| account_id | TourCMS account ID | ||||||||||||||||||||||||||
| channel_id | TourCMS channel ID | ||||||||||||||||||||||||||
| booking |
A booking node containing the following:
|