All URIs are relative to https://api.digitalriver.com
| Method | HTTP request | Description |
|---|---|---|
| createDropInCheckoutLink | POST /drop-in/checkout-links | Creates a new Drop-in checkout link |
| deleteDropInCheckoutLinks | DELETE /drop-in/checkout-links/{id} | Deletes a Drop-in checkout link by ID. |
| listDropInCheckoutLink | GET /drop-in/checkout-links | List Drop-in checkout links |
\DigitalRiver\ApiSdk\Model\DropInCheckoutLinkResponse createDropInCheckoutLink($drop_in_checkout_link)
Creates a new Drop-in checkout link
Creates a new Drop-in checkout link
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer authorization: bearerAuth
$config = DigitalRiver\ApiSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new DigitalRiver\ApiSdk\Api\DropInCheckoutLinksApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$drop_in_checkout_link = new \DigitalRiver\ApiSdk\Model\DropInCheckoutLink(); // \DigitalRiver\ApiSdk\Model\DropInCheckoutLink |
// Refer \DigitalRiver\ApiSdk\Model\DropInCheckoutLink::$setters in digital-river-php/lib/Model/DropInCheckoutLink.php to set the properties.
try {
$result = $apiInstance->createDropInCheckoutLink($drop_in_checkout_link);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DropInCheckoutLinksApi->createDropInCheckoutLink: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| drop_in_checkout_link | \DigitalRiver\ApiSdk\Model\DropInCheckoutLink | [optional] |
\DigitalRiver\ApiSdk\Model\DropInCheckoutLinkResponse
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteDropInCheckoutLinks($id)
Deletes a Drop-in checkout link by ID.
Deletes the checkout link so it cannot be used after this operation.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer authorization: bearerAuth
$config = DigitalRiver\ApiSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new DigitalRiver\ApiSdk\Api\DropInCheckoutLinksApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$id = 'id_example'; // string | Link ID
try {
$apiInstance->deleteDropInCheckoutLinks($id);
} catch (Exception $e) {
echo 'Exception when calling DropInCheckoutLinksApi->deleteDropInCheckoutLinks: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | Link ID |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\DigitalRiver\ApiSdk\Model\ListCheckoutLinksResponse listDropInCheckoutLink($created_time, $ending_before, $starting_after, $limit, $ids)
List Drop-in checkout links
Get all checkout links.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure Bearer authorization: bearerAuth
$config = DigitalRiver\ApiSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new DigitalRiver\ApiSdk\Api\DropInCheckoutLinksApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$created_time = createdTime[gt]=2020-09-22T12:09:44Z; // map[string,\DateTime] | A filter on the list based on the **createdTime** field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options: - **eq**—return values where the createdTime field equals to this timestamp - **gt**—return values where the createdTime field is after this timestamp - **gte**—return values where the createdTime field is after or equal to this timestamp - **lt**—return values where the createdTime field is before this timestamp - **lte**—return values where the createdTime field is before or equal to this timestamp
// Refer map[string,\DateTime]::$setters in digital-river-php/lib/Model/\DateTime.php to set the properties.
$ending_before = 'ending_before_example'; // string | A cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list.
$starting_after = 'starting_after_example'; // string | A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list.
$limit = 56; // int | A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.
$ids = array('ids_example'); // string[] | Only return objects with these IDs.
// Refer string[]::$setters in digital-river-php/lib/Model/string.php to set the properties.
try {
$result = $apiInstance->listDropInCheckoutLink($created_time, $ending_before, $starting_after, $limit, $ids);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DropInCheckoutLinksApi->listDropInCheckoutLink: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| created_time | map[string,\DateTime] | A filter on the list based on the createdTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options: - eq—return values where the createdTime field equals to this timestamp - gt—return values where the createdTime field is after this timestamp - gte—return values where the createdTime field is after or equal to this timestamp - lt—return values where the createdTime field is before this timestamp - lte—return values where the createdTime field is before or equal to this timestamp | [optional] |
| ending_before | string | A cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list. | [optional] |
| starting_after | string | A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list. | [optional] |
| limit | int | A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10. | [optional] |
| ids | string[] | Only return objects with these IDs. | [optional] |
\DigitalRiver\ApiSdk\Model\ListCheckoutLinksResponse
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]