Skip to content

Latest commit

 

History

History
278 lines (204 loc) · 9.18 KB

PaymentsApi.md

File metadata and controls

278 lines (204 loc) · 9.18 KB

PaymentsApi

All URIs are relative to https://pal-test.adyen.com/pal/servlet/Payment/v68

Method HTTP request Description
postAuthorise POST /authorise Create an authorisation
postAuthorise3d POST /authorise3d Complete a 3DS authorisation
postAuthorise3ds2 POST /authorise3ds2 Complete a 3DS2 authorisation
postGetAuthenticationResult POST /getAuthenticationResult Get the 3DS authentication result
postRetrieve3ds2Result POST /retrieve3ds2Result Get the 3DS2 authentication result

postAuthorise

PaymentResult postAuthorise(paymentRequest)

Create an authorisation

Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation. > This endpoint is part of our classic API integration. If using a newer integration, use the `/payments` endpoint under Checkout API instead.

Example

// Import classes:
//import com.adyen.client.infrastructure.*
//import com.adyen.model.payment.*

val apiInstance = PaymentsApi()
val paymentRequest : PaymentRequest =  // PaymentRequest | 
try {
    val result : PaymentResult = apiInstance.postAuthorise(paymentRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PaymentsApi#postAuthorise")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PaymentsApi#postAuthorise")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
paymentRequest PaymentRequest [optional]

Return type

PaymentResult

Authorization

Configure ApiKeyAuth: ApiClient.apiKey["X-API-Key"] = "" ApiClient.apiKeyPrefix["X-API-Key"] = "" Configure BasicAuth: ApiClient.username = "" ApiClient.password = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

postAuthorise3d

PaymentResult postAuthorise3d(paymentRequest3d)

Complete a 3DS authorisation

For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters that you get from the card issuer after a shopper pays via 3D Secure. > This endpoint is part of our classic API integration. If using a newer integration, use the `/payments/details` endpoint under Checkout API instead.

Example

// Import classes:
//import com.adyen.client.infrastructure.*
//import com.adyen.model.payment.*

val apiInstance = PaymentsApi()
val paymentRequest3d : PaymentRequest3d =  // PaymentRequest3d | 
try {
    val result : PaymentResult = apiInstance.postAuthorise3d(paymentRequest3d)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PaymentsApi#postAuthorise3d")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PaymentsApi#postAuthorise3d")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
paymentRequest3d PaymentRequest3d [optional]

Return type

PaymentResult

Authorization

Configure ApiKeyAuth: ApiClient.apiKey["X-API-Key"] = "" ApiClient.apiKeyPrefix["X-API-Key"] = "" Configure BasicAuth: ApiClient.username = "" ApiClient.password = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

postAuthorise3ds2

PaymentResult postAuthorise3ds2(paymentRequest3ds2)

Complete a 3DS2 authorisation

For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` parameters. > This endpoint is part of our classic API integration. If using a newer integration, use the `/payments/details` endpoint under Checkout API instead.

Example

// Import classes:
//import com.adyen.client.infrastructure.*
//import com.adyen.model.payment.*

val apiInstance = PaymentsApi()
val paymentRequest3ds2 : PaymentRequest3ds2 =  // PaymentRequest3ds2 | 
try {
    val result : PaymentResult = apiInstance.postAuthorise3ds2(paymentRequest3ds2)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PaymentsApi#postAuthorise3ds2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PaymentsApi#postAuthorise3ds2")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
paymentRequest3ds2 PaymentRequest3ds2 [optional]

Return type

PaymentResult

Authorization

Configure ApiKeyAuth: ApiClient.apiKey["X-API-Key"] = "" ApiClient.apiKeyPrefix["X-API-Key"] = "" Configure BasicAuth: ApiClient.username = "" ApiClient.password = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

postGetAuthenticationResult

AuthenticationResultResponse postGetAuthenticationResult(authenticationResultRequest)

Get the 3DS authentication result

Return the authentication result after doing a 3D Secure authentication only.

Example

// Import classes:
//import com.adyen.client.infrastructure.*
//import com.adyen.model.payment.*

val apiInstance = PaymentsApi()
val authenticationResultRequest : AuthenticationResultRequest =  // AuthenticationResultRequest | 
try {
    val result : AuthenticationResultResponse = apiInstance.postGetAuthenticationResult(authenticationResultRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PaymentsApi#postGetAuthenticationResult")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PaymentsApi#postGetAuthenticationResult")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
authenticationResultRequest AuthenticationResultRequest [optional]

Return type

AuthenticationResultResponse

Authorization

Configure ApiKeyAuth: ApiClient.apiKey["X-API-Key"] = "" ApiClient.apiKeyPrefix["X-API-Key"] = "" Configure BasicAuth: ApiClient.username = "" ApiClient.password = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

postRetrieve3ds2Result

ThreeDS2ResultResponse postRetrieve3ds2Result(threeDS2ResultRequest)

Get the 3DS2 authentication result

Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only.

Example

// Import classes:
//import com.adyen.client.infrastructure.*
//import com.adyen.model.payment.*

val apiInstance = PaymentsApi()
val threeDS2ResultRequest : ThreeDS2ResultRequest =  // ThreeDS2ResultRequest | 
try {
    val result : ThreeDS2ResultResponse = apiInstance.postRetrieve3ds2Result(threeDS2ResultRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PaymentsApi#postRetrieve3ds2Result")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PaymentsApi#postRetrieve3ds2Result")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
threeDS2ResultRequest ThreeDS2ResultRequest [optional]

Return type

ThreeDS2ResultResponse

Authorization

Configure ApiKeyAuth: ApiClient.apiKey["X-API-Key"] = "" ApiClient.apiKeyPrefix["X-API-Key"] = "" Configure BasicAuth: ApiClient.username = "" ApiClient.password = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json