|
| 1 | +# CyberSource\PayerAuthenticationApi |
| 2 | + |
| 3 | +All URIs are relative to *https://apitest.cybersource.com* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**checkPayerAuthEnrollment**](PayerAuthenticationApi.md#checkPayerAuthEnrollment) | **POST** /risk/v1/authentications | Check payer auth enrollment |
| 8 | +[**validateAuthenticationResults**](PayerAuthenticationApi.md#validateAuthenticationResults) | **POST** /risk/v1/authentication-results | Validate authentication results |
| 9 | + |
| 10 | + |
| 11 | +# **checkPayerAuthEnrollment** |
| 12 | +> \CyberSource\Model\RiskV1AuthenticationsPost201Response checkPayerAuthEnrollment($checkPayerAuthEnrollmentRequest) |
| 13 | +
|
| 14 | +Check payer auth enrollment |
| 15 | + |
| 16 | +This call verifies that the card is enrolled in a card authentication program. |
| 17 | + |
| 18 | +### Example |
| 19 | +```php |
| 20 | +<?php |
| 21 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 22 | + |
| 23 | +$api_instance = new CyberSource\Api\PayerAuthenticationApi(); |
| 24 | +$checkPayerAuthEnrollmentRequest = new \CyberSource\Model\CheckPayerAuthEnrollmentRequest(); // \CyberSource\Model\CheckPayerAuthEnrollmentRequest | |
| 25 | + |
| 26 | +try { |
| 27 | + $result = $api_instance->checkPayerAuthEnrollment($checkPayerAuthEnrollmentRequest); |
| 28 | + print_r($result); |
| 29 | +} catch (Exception $e) { |
| 30 | + echo 'Exception when calling PayerAuthenticationApi->checkPayerAuthEnrollment: ', $e->getMessage(), PHP_EOL; |
| 31 | +} |
| 32 | +?> |
| 33 | +``` |
| 34 | + |
| 35 | +### Parameters |
| 36 | + |
| 37 | +Name | Type | Description | Notes |
| 38 | +------------- | ------------- | ------------- | ------------- |
| 39 | + **checkPayerAuthEnrollmentRequest** | [**\CyberSource\Model\CheckPayerAuthEnrollmentRequest**](../Model/CheckPayerAuthEnrollmentRequest.md)| | |
| 40 | + |
| 41 | +### Return type |
| 42 | + |
| 43 | +[**\CyberSource\Model\RiskV1AuthenticationsPost201Response**](../Model/RiskV1AuthenticationsPost201Response.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/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 | +# **validateAuthenticationResults** |
| 57 | +> \CyberSource\Model\RiskV1AuthenticationResultsPost201Response validateAuthenticationResults($request) |
| 58 | +
|
| 59 | +Validate authentication results |
| 60 | + |
| 61 | +This call retrieves and validates the authentication results from issuer and allows the merchant to proceed with processing the payment. |
| 62 | + |
| 63 | +### Example |
| 64 | +```php |
| 65 | +<?php |
| 66 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 67 | + |
| 68 | +$api_instance = new CyberSource\Api\PayerAuthenticationApi(); |
| 69 | +$request = new \CyberSource\Model\Request(); // \CyberSource\Model\Request | |
| 70 | + |
| 71 | +try { |
| 72 | + $result = $api_instance->validateAuthenticationResults($request); |
| 73 | + print_r($result); |
| 74 | +} catch (Exception $e) { |
| 75 | + echo 'Exception when calling PayerAuthenticationApi->validateAuthenticationResults: ', $e->getMessage(), PHP_EOL; |
| 76 | +} |
| 77 | +?> |
| 78 | +``` |
| 79 | + |
| 80 | +### Parameters |
| 81 | + |
| 82 | +Name | Type | Description | Notes |
| 83 | +------------- | ------------- | ------------- | ------------- |
| 84 | + **request** | [**\CyberSource\Model\Request**](../Model/Request.md)| | |
| 85 | + |
| 86 | +### Return type |
| 87 | + |
| 88 | +[**\CyberSource\Model\RiskV1AuthenticationResultsPost201Response**](../Model/RiskV1AuthenticationResultsPost201Response.md) |
| 89 | + |
| 90 | +### Authorization |
| 91 | + |
| 92 | +No authorization required |
| 93 | + |
| 94 | +### HTTP request headers |
| 95 | + |
| 96 | + - **Content-Type**: application/json;charset=utf-8 |
| 97 | + - **Accept**: application/json;charset=utf-8 |
| 98 | + |
| 99 | +[[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) |
| 100 | + |
0 commit comments