Create a payment link

POST

/paymentLinks

Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the currency and country parameters sent in the request.

For more information, refer to Pay by Link documentation.

Request

Header Params

Body Params application/json

Examples

Responses

🟢200OK - the request has succeeded.

application/json

Body

🟢201Created - the request has succeeded.

🟠400Bad Request - a problem reading or understanding the request.

🟠401Unauthorized - authentication required.

🟠403Forbidden - insufficient permissions to process the request.

🟠422Unprocessable Entity - a request validation error.

🔴500Internal Server Error - the server could not process the request.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/paymentLinks' \
--header 'Content-Type: application/json' \
--data-raw '{
    "allowedPaymentMethods": [
        "string"
    ],
    "amount": {
        "currency": "str",
        "value": 0
    },
    "applicationInfo": {
        "adyenLibrary": {
            "name": "string",
            "version": "string"
        },
        "adyenPaymentSource": {
            "name": "string",
            "version": "string"
        },
        "externalPlatform": {
            "integrator": "string",
            "name": "string",
            "version": "string"
        },
        "merchantApplication": {
            "name": "string",
            "version": "string"
        },
        "merchantDevice": {
            "os": "string",
            "osVersion": "string",
            "reference": "string"
        },
        "shopperInteractionDevice": {
            "locale": "string",
            "os": "string",
            "osVersion": "string"
        }
    },
    "billingAddress": {
        "city": "string",
        "country": "string",
        "houseNumberOrName": "string",
        "postalCode": "string",
        "stateOrProvince": "string",
        "street": "string"
    },
    "blockedPaymentMethods": [
        "string"
    ],
    "countryCode": "string",
    "deliverAt": "2019-08-24T14:15:22Z",
    "deliveryAddress": {
        "city": "string",
        "country": "string",
        "houseNumberOrName": "string",
        "postalCode": "string",
        "stateOrProvince": "string",
        "street": "string"
    },
    "description": "string",
    "expiresAt": "string",
    "installmentOptions": {
        "property1": {
            "maxValue": 0,
            "plans": [
                "regular"
            ],
            "preselectedValue": 0,
            "values": [
                0
            ]
        },
        "property2": {
            "maxValue": 0,
            "plans": [
                "regular"
            ],
            "preselectedValue": 0,
            "values": [
                0
            ]
        }
    },
    "lineItems": [
        {
            "amountExcludingTax": 0,
            "amountIncludingTax": 0,
            "description": "string",
            "id": "string",
            "imageUrl": "string",
            "itemCategory": "string",
            "productUrl": "string",
            "quantity": 0,
            "taxAmount": 0,
            "taxPercentage": 0
        }
    ],
    "manualCapture": true,
    "merchantAccount": "string",
    "merchantOrderReference": "string",
    "metadata": {
        "property1": "string",
        "property2": "string"
    },
    "recurringProcessingModel": "CardOnFile",
    "reference": "string",
    "requiredShopperFields": [
        "billingAddress"
    ],
    "returnUrl": "string",
    "reusable": true,
    "riskData": {
        "clientData": "string",
        "customFields": {
            "property1": "string",
            "property2": "string"
        },
        "fraudOffset": 0,
        "profileReference": "string"
    },
    "shopperEmail": "string",
    "shopperLocale": "string",
    "shopperName": {
        "firstName": "string",
        "lastName": "string"
    },
    "shopperReference": "string",
    "showRemovePaymentMethodButton": true,
    "splits": [
        {
            "account": "string",
            "amount": {
                "currency": "str",
                "value": 0
            },
            "description": "string",
            "reference": "string",
            "type": "BalanceAccount"
        }
    ],
    "store": "string",
    "storePaymentMethodMode": "askForConsent",
    "telephoneNumber": "string",
    "themeId": "string"
}'

Response Example

200 - Example 1

{
    "allowedPaymentMethods": [
        "string"
    ],
    "amount": {
        "currency": "str",
        "value": 0
    },
    "applicationInfo": {
        "adyenLibrary": {
            "name": "string",
            "version": "string"
        },
        "adyenPaymentSource": {
            "name": "string",
            "version": "string"
        },
        "externalPlatform": {
            "integrator": "string",
            "name": "string",
            "version": "string"
        },
        "merchantApplication": {
            "name": "string",
            "version": "string"
        },
        "merchantDevice": {
            "os": "string",
            "osVersion": "string",
            "reference": "string"
        },
        "shopperInteractionDevice": {
            "locale": "string",
            "os": "string",
            "osVersion": "string"
        }
    },
    "billingAddress": {
        "city": "string",
        "country": "string",
        "houseNumberOrName": "string",
        "postalCode": "string",
        "stateOrProvince": "string",
        "street": "string"
    },
    "blockedPaymentMethods": [
        "string"
    ],
    "countryCode": "string",
    "deliverAt": "2019-08-24T14:15:22Z",
    "deliveryAddress": {
        "city": "string",
        "country": "string",
        "houseNumberOrName": "string",
        "postalCode": "string",
        "stateOrProvince": "string",
        "street": "string"
    },
    "description": "string",
    "expiresAt": "string",
    "id": "string",
    "installmentOptions": {
        "property1": {
            "maxValue": 0,
            "plans": [
                "regular"
            ],
            "preselectedValue": 0,
            "values": [
                0
            ]
        },
        "property2": {
            "maxValue": 0,
            "plans": [
                "regular"
            ],
            "preselectedValue": 0,
            "values": [
                0
            ]
        }
    },
    "lineItems": [
        {
            "amountExcludingTax": 0,
            "amountIncludingTax": 0,
            "description": "string",
            "id": "string",
            "imageUrl": "string",
            "itemCategory": "string",
            "productUrl": "string",
            "quantity": 0,
            "taxAmount": 0,
            "taxPercentage": 0
        }
    ],
    "manualCapture": true,
    "merchantAccount": "string",
    "merchantOrderReference": "string",
    "metadata": {
        "property1": "string",
        "property2": "string"
    },
    "recurringProcessingModel": "CardOnFile",
    "reference": "string",
    "requiredShopperFields": [
        "billingAddress"
    ],
    "returnUrl": "string",
    "reusable": true,
    "riskData": {
        "clientData": "string",
        "customFields": {
            "property1": "string",
            "property2": "string"
        },
        "fraudOffset": 0,
        "profileReference": "string"
    },
    "shopperEmail": "string",
    "shopperLocale": "string",
    "shopperName": {
        "firstName": "string",
        "lastName": "string"
    },
    "shopperReference": "string",
    "showRemovePaymentMethodButton": true,
    "splits": [
        {
            "account": "string",
            "amount": {
                "currency": "str",
                "value": 0
            },
            "description": "string",
            "reference": "string",
            "type": "BalanceAccount"
        }
    ],
    "status": "active",
    "store": "string",
    "storePaymentMethodMode": "askForConsent",
    "telephoneNumber": "string",
    "themeId": "string",
    "updatedAt": "2019-08-24T14:15:22Z",
    "url": "string"
}

Modified at 2023-08-15 09:16:27

Create originKey values for domains

Get a payment link