|
| 1 | +# CyberSource\OrdersApi |
| 2 | + |
| 3 | +All URIs are relative to *https://apitest.cybersource.com* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**createOrder**](OrdersApi.md#createOrder) | **POST** /pts/v2/intents | Create an Order |
| 8 | +[**updateOrder**](OrdersApi.md#updateOrder) | **PATCH** /pts/v2/intents/{id} | Update an Order |
| 9 | + |
| 10 | + |
| 11 | +# **createOrder** |
| 12 | +> \CyberSource\Model\PtsV2CreateOrderPost201Response createOrder($createOrderRequest) |
| 13 | +
|
| 14 | +Create an Order |
| 15 | + |
| 16 | +A create order request enables you to send the itemized details along with the order. This API can be used by merchants initiating their transactions with the create order API. |
| 17 | + |
| 18 | +### Example |
| 19 | +```php |
| 20 | +<?php |
| 21 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 22 | + |
| 23 | +$api_instance = new CyberSource\Api\OrdersApi(); |
| 24 | +$createOrderRequest = new \CyberSource\Model\CreateOrderRequest(); // \CyberSource\Model\CreateOrderRequest | |
| 25 | + |
| 26 | +try { |
| 27 | + $result = $api_instance->createOrder($createOrderRequest); |
| 28 | + print_r($result); |
| 29 | +} catch (Exception $e) { |
| 30 | + echo 'Exception when calling OrdersApi->createOrder: ', $e->getMessage(), PHP_EOL; |
| 31 | +} |
| 32 | +?> |
| 33 | +``` |
| 34 | + |
| 35 | +### Parameters |
| 36 | + |
| 37 | +Name | Type | Description | Notes |
| 38 | +------------- | ------------- | ------------- | ------------- |
| 39 | + **createOrderRequest** | [**\CyberSource\Model\CreateOrderRequest**](../Model/CreateOrderRequest.md)| | |
| 40 | + |
| 41 | +### Return type |
| 42 | + |
| 43 | +[**\CyberSource\Model\PtsV2CreateOrderPost201Response**](../Model/PtsV2CreateOrderPost201Response.md) |
| 44 | + |
| 45 | +### Authorization |
| 46 | + |
| 47 | +No authorization required |
| 48 | + |
| 49 | +### HTTP request headers |
| 50 | + |
| 51 | + - **Content-Type**: application/json;charset=utf-8 |
| 52 | + - **Accept**: application/hal+json;charset=utf-8 |
| 53 | + |
| 54 | +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) |
| 55 | + |
| 56 | +# **updateOrder** |
| 57 | +> \CyberSource\Model\PtsV2UpdateOrderPatch201Response updateOrder($id, $updateOrderRequest) |
| 58 | +
|
| 59 | +Update an Order |
| 60 | + |
| 61 | +This API can be used in two flavours - for updating the order as well as saving the order. |
| 62 | + |
| 63 | +### Example |
| 64 | +```php |
| 65 | +<?php |
| 66 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 67 | + |
| 68 | +$api_instance = new CyberSource\Api\OrdersApi(); |
| 69 | +$id = "id_example"; // string | The ID returned from the original create order response. |
| 70 | +$updateOrderRequest = new \CyberSource\Model\UpdateOrderRequest(); // \CyberSource\Model\UpdateOrderRequest | |
| 71 | + |
| 72 | +try { |
| 73 | + $result = $api_instance->updateOrder($id, $updateOrderRequest); |
| 74 | + print_r($result); |
| 75 | +} catch (Exception $e) { |
| 76 | + echo 'Exception when calling OrdersApi->updateOrder: ', $e->getMessage(), PHP_EOL; |
| 77 | +} |
| 78 | +?> |
| 79 | +``` |
| 80 | + |
| 81 | +### Parameters |
| 82 | + |
| 83 | +Name | Type | Description | Notes |
| 84 | +------------- | ------------- | ------------- | ------------- |
| 85 | + **id** | **string**| The ID returned from the original create order response. | |
| 86 | + **updateOrderRequest** | [**\CyberSource\Model\UpdateOrderRequest**](../Model/UpdateOrderRequest.md)| | |
| 87 | + |
| 88 | +### Return type |
| 89 | + |
| 90 | +[**\CyberSource\Model\PtsV2UpdateOrderPatch201Response**](../Model/PtsV2UpdateOrderPatch201Response.md) |
| 91 | + |
| 92 | +### Authorization |
| 93 | + |
| 94 | +No authorization required |
| 95 | + |
| 96 | +### HTTP request headers |
| 97 | + |
| 98 | + - **Content-Type**: application/json;charset=utf-8 |
| 99 | + - **Accept**: application/hal+json;charset=utf-8 |
| 100 | + |
| 101 | +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) |
| 102 | + |
0 commit comments