You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
#### Standing Instruction: Standing Instruction with or without Token. #### Revoke Mandate: When you revoke a mandate, any pending direct debits linked to that mandate are canceled. No notifications are sent. When you revoke a mandate with no pending direct debits, the Bacs scheme or customer's bank notify you of any subsequent direct debit events. When you revoke a mandate, you cannot send a direct debit request using the mandate ID. Customer payments cannot be made against a revoked mandate. You can revoke a mandate when the customer: - Requests that you revoke the mandate. - Closes their account with you. Possible revoke mandate status values - - Revoked—the revoke mandate request was successfully processed. - Failed—the revoke mandate request was not accepted. #### Update Mandate: In most cases, the account details of an existing mandate cannot be updated in the Bacs schema, except by creating a new mandate. However, some very limited customer information, like name and address, can be updated to the mandate without needing to revoke it first #### Mandate Status: After the customer signs the mandate, request that the mandate status service verify the mandate status. Possible mandate status values: - Active—the mandate is successfully created. A direct debit can be sent for this mandate ID. - Pending—a pending mandate means the mandate is not yet signed. - Failed—the customer did not authenticate. - Expired—the deadline to create the mandate passed. - Revoked—the mandate is cancelled. #### Paypal Billing Agreement: A billing agreement is set up between PayPal and your customer. When you collect the details of a customer's billing agreement, you are able to bill that customer without requiring an authorization for each payment. You can bill the customer at the same time you process their PayPal Express checkout order, which simplifies your business processes.
18
18
19
19
### Example
20
20
```php
@@ -43,7 +43,7 @@ Name | Type | Description | Notes
[[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)
Standing Instructionwith or without Token. Transaction amount in case First payment is coming along with registration. Only 2 decimal places allowed
111
+
#### Standing Instruction: Standing Instruction with or without Token. Transaction amount in case First payment is coming along with registration. Only 2 decimal places allowed #### Create Mandate: You can create a mandate through the direct debit mandate flow. Possible create mandate status values: - Pending—the create mandate request was successfully processed. - Failed—the create mandate request was not accepted. #### Import Mandate: In the Bacs scheme, a mandate is created with a status of active. Direct debit collections can be made against it immediately. You can import a mandate to the CyberSource database when: - You have existing customers with signed, active mandates - You manage mandates outside of CyberSource. When you import an existing mandate to the CyberSource database, provide a unique value for the mandate ID or the request results in an error. If an import mandate request is not accepted, the import mandate status value is failed.
112
112
113
113
### Example
114
114
```php
@@ -135,7 +135,7 @@ Name | Type | Description | Notes
[[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)
[[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)
[[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)
[[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)
[[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)
Copy file name to clipboardExpand all lines: docs/Api/TransientTokenDataApi.md
+46
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,55 @@ All URIs are relative to *https://apitest.cybersource.com*
4
4
5
5
Method | HTTP request | Description
6
6
------------- | ------------- | -------------
7
+
[**getPaymentCredentialsForTransientToken**](TransientTokenDataApi.md#getPaymentCredentialsForTransientToken) | **GET** /up/v1/payment-credentials/{jti} | Get Payment Credentials
7
8
[**getTransactionForTransientToken**](TransientTokenDataApi.md#getTransactionForTransientToken) | **GET** /up/v1/payment-details/{transientToken} | Get Transient Token Data
Retrieve the Payment data captured by Unified Checkout. This API is used to retrieve the detailed data represented by the Transient Token. This API will return PCI payment data captured by the Unified Checkout platform.
17
+
18
+
### Example
19
+
```php
20
+
<?php
21
+
require_once(__DIR__ . '/vendor/autoload.php');
22
+
23
+
$api_instance = new CyberSource\Api\TransientTokenDataApi();
24
+
$jti = "jti_example"; // string | The jti field contained within the Transient token returned from a successful Unified Checkout transaction
**jti** | **string**| The jti field contained within the Transient token returned from a successful Unified Checkout transaction |
40
+
41
+
### Return type
42
+
43
+
**string**
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/json
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)
Generate a one-time use capture context used for the invocation of Unified Checkout. The Request wil contain all of the parameters for how Unified Checkout will operate within a client webpage. The resulting payload will be a JWT signed object that can be used to initiate Unified Checkout within a merchant web page
15
+
Unified Checkout is a powerful product within the Digital Acceptance Suite. Unified Checkout is designed to assist merchants with the adoption and inclusion of digital payments within their payment acceptance page. With Unified Checkout Integration you can add digital payment methods to create familiar, convenient and seamless payment experiences that are designed to reduce checkout friction and increase conversions. Click to Pay Drop-in UI is built on the Unified Checkout platform. For more information about Unified Checkout, see the [Unified Checkout Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-intro.html). For examples on how to integrate Unified Checkout within your webpage please see our [GitHub Unified Checkout Samples](https://github.com/CyberSource/cybersource-unified-checkout-sample-java). For more information about Click to Pay drop in UI, see the [Click to Pay Drop-in UI Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/click-to-pay/developer/all/rest/click-to-pay/ctp-intro.html). Generate Unified Checkout Capture Context Generate a one-time use capture context used for the invocation of Unified Checkout. The Request wil contain all of the parameters for how Unified Checkout will operate within a client webpage. The resulting payload will be a JWT signed object that can be used to initiate Unified Checkout or Click to Pay Drop-in UI within a web page
[[Back to Model list]](../README.md#documentation-for-models)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to README]](../README.md)
**processors** | [**map[string,\CyberSource\Model\CardProcessingConfigCommonProcessors]**](CardProcessingConfigCommonProcessors.md) | e.g. * amexdirect * barclays2 * CUP * EFTPOS * fdiglobal * gpx * smartfdc * tsys * vero * VPC For VPC, CUP and EFTPOS processors, replace the processor name from VPC or CUP or EFTPOS to the actual processor name in the sample request. e.g. replace VPC with &lt;your vpc processor&gt; | [optional]
6
+
**processors** | [**map[string,\CyberSource\Model\CardProcessingConfigCommonProcessors]**](CardProcessingConfigCommonProcessors.md) | e.g. * amexdirect * barclays2 * CUP * EFTPOS * fdiglobal * gpngsapv3 * gpx * smartfdc * tsys * vero * VPC For VPC, CUP and EFTPOS processors, replace the processor name from VPC or CUP or EFTPOS to the actual processor name in the sample request. e.g. replace VPC with &lt;your vpc processor&gt; | [optional]
7
7
**amexVendorCode** | **string** | Vendor code assigned by American Express. Applicable for TSYS (tsys) processor. | [optional]
8
8
**defaultAuthTypeCode** | **string** | Authorization Finality indicator. Please note that the input can be in small case or capitals but response is in small case as of now. It will be made capitals everywhere in the next version. Applicable for Elavon Americas (elavonamericas), TSYS (tsys), Barclays (barclays2), Streamline (streamline2), Six (six), Barclays HISO (barclayshiso), GPN (gpn), FDI Global (fdiglobal), GPX (gpx), Paymentech Tampa (paymentechtampa), FDC Nashville (smartfdc), VPC and Chase Paymentech Salem (chasepaymentechsalem) processors. Validation details (for selected processors)... <table> <thead><tr><th>Processor</th><th>Acceptance Type</th><th>Required</th><th>Default Value</th></tr></thead> <tr><td>Barclays</td><td>cnp, cp, hybrid</td><td>No</td><td>FINAL</td></tr> <tr><td>Barclays HISO</td><td>cnp, cp, hybrid</td><td>Yes</td><td>FINAL</td></tr> </table> | [optional]
9
9
**masterCardAssignedId** | **string** | MAID aka MasterCard assigned ID, MasterCard equivalent of Merchant Verification Value by Visa. Applicable for VPC, GPX (gpx) and FDI Global (fdiglobal) processors. | [optional]
0 commit comments