POST PaymentByLink by context, contextId
Overview
Generate Link for Adyen Pay By Link Option
Request
POST /[context]/[contextId]/PaymentByLink
Request Information
Request Parameters
Name
Type
Requirement
Description
description
String
Optional
Description. Required to display in the payment page
shopperName
String
Optional
ShopperName. Required to display in the payment page
shopperEmail
String
Optional
shopperEmail. Mandatory when payment is using 3DS2
expiresAtUTC
DateTime
Optional
expiresAt. The date that the payment link expires in local time.
paymentMethodId
Integer
Optional
Payment Method Id (Should be 32 for Adyen)
amount
Decimal
Mandatory
Amount (excluding donation amount)
donationAmount
Decimal
Optional
Donation Amount
currencyCode
String
Mandatory
CurrencyCode
Request Example
{
"description": "Payment for booking number 6533456",
"shopperName": "Sam Smith",
"shopperEmail": "example@email.com",
"expiresAtUTC": "2019-11-23T12:25:28Z",
"paymentMethodId": 32,
"amount": 2500.0,
"donationAmount": 25.0,
"currencyCode": "USD"
}Response Information
Response Properties
Name
Type
Description
amount
Decimal
Amount Payment Requested
currencyCode
String
Currency code
paymentReference
String
PaymentReference
paymentContextType
String
PaymentContextType
link
String
Link
expiresAtUTC
String
Link Expires Date in ISO 8601 format
Response Codes
HTTP status code
Description
200 OK
The resource was updated successfully
201 Created
The resource was created
400 Bad Request
The resource was malformed
401 Unauthorized
Missing or invalid API key
500 Internal Server Error
An unexpected error occurred on the API server
202 Accepted
The request was accepted
404 Not Found
The specified resource was not found
403 Forbidden
One or more parameters has already been set on the resource record and cannot be updated
Response Example
{
"amount": 2500.0,
"currencyCode": "USD",
"paymentReference": "4357886618",
"paymentContextType": "Txn or TxnParticipant",
"link": "http://",
"expiresAtUTC": "2019-11-23T12:25:28Z"
}