PAYONE Link API (v1)

Download OpenAPI specification:Download

E-mail: [email protected] URL: https://www.payone.com/kontakt/

Find more info here

Link Management

Endpoints intended for server-to-server communication.

List all payment links.

Authorizations:

getMultipleAuth

query Parameters

page	integer <int32> Default: 0
limit	integer <int32> Default: 25
merchantId required	string[0-9]+
accountId required	string[0-9]+
portalId required	string[0-9]+
mode required	stringlive\|test

Responses

Response samples

Content type

application/json

{"totalPages": 0,
"totalElements": 0,
"size": 0,
"content": [{"id": "HUENJ5FY124QHUENJ5FY124QHUENJ5FY",
"currency": "EUR",
"amount": 799,
"created": 0,
"modified": 0,
"intent": "authorization",
"paymentMethods": ["visa",
"mastercard"
],
"status": "ready",
"expiration": "2020-02-20",
"description": "This payment is awesome!!",
"reference": "payment_1",
"hash": "a42847abb8bfca62876ca64c0fa981f8",
"redirectUrl": "string",
"notifyUrl": "string",
"paymentProcess": "347867997",
"userId": "356845874",
"paymentMethod": "visa",
"shipping": {"firstName": "John",
"lastName": "Doe",
"company": "PAYONE GmbH",
"street": "Fraunhoferstr. 2-4",
"addressAddition": "7th floor",
"zip": "24118",
"city": "Kiel",
"state": "st",
"country": "DE"
},
"billing": {"firstName": "John",
"lastName": "Doe",
"company": "PAYONE GmbH",
"street": "Fraunhoferstr. 2-4",
"addressAddition": "7th floor",
"zip": "24118",
"city": "Kiel",
"state": "st",
"country": "DE"
},
"shoppingCart": [{"type": "goods",
"number": "73883HFJ",
"price": 1999,
"quantity": 1,
"description": "Potatoes",
"vatRate": 20,
"deliveryDateStart": "2021-01-01",
"deliveryDateEnd": "2021-01-01"
}
],
"language": "en_US",
"logo": "https://www.payone.com/wp-content/uploads/2018/12/Payone-Logo-2020.jpg",
"backgroundImage": "linear-gradient(to bottom right, #ffffff, #3295d6)",
"accountId": "12345",
"merchantId": "12345",
"portalId": "1234567",
"mode": "live",
"active": true,
"successUrl": "string",
"errorUrl": "string",
"backUrl": "string",
"email": "string",
"invoiceInformation": {"invoiceId": "string",
"invoiceText": "string"
},
"link": "string"
}
],
"number": 0,
"first": true,
"sort": {"sorted": true,
"unsorted": true,
"empty": true
},
"numberOfElements": 0,
"pageable": {"offset": 0,
"sort": {"sorted": true,
"unsorted": true,
"empty": true
},
"pageNumber": 0,
"pageSize": 0,
"unpaged": true,
"paged": true
},
"last": true,
"empty": true
}

Create a payment link.

Authorizations:

createAuth

Request Body schema: application/json

intent	string Default: "authorization" Enum: "authorization" "preauthorization" designates the type of transaction that will be created
currency required	string = 3 characters Enum: "ALL" "DZD" "ARS" "AUD" "BSD" "BHD" "BDT" "AMD" "BBD" "BMD" "BTN" "BOB" "BWP" "BZD" "SBD" "BND" "MMK" "BIF" "KHR" "CAD" "CVE" "KYD" "LKR" "CLP" "CNY" "COP" "KMF" "CRC" "HRK" "CUP" "CZK" "DKK" "DOP" "SVC" "ETB" "ERN" "FKP" "FJD" "DJF" "GMD" "GIP" "GTQ" "GNF" "GYD" "HTG" "HNL" "HKD" "HUF" "ISK" "INR" "IDR" "IRR" "IQD" "ILS" "JMD" "JPY" "KZT" "JOD" "KES" "KPW" "KRW" "KWD" "KGS" "LAK" "LBP" "LSL" "LRD" "LYD" "MOP" "MWK" "MYR" "MVR" "MUR" "MXN" "MNT" "MDL" "MAD" "OMR" "NAD" "NPR" "ANG" "AWG" "VUV" "NZD" "NIO" "NGN" "NOK" "PKR" "PAB" "PGK" "PYG" "PEN" "PHP" "QAR" "RUB" "RWF" "SHP" "SAR" "SCR" "SLL" "SGD" "VND" "SOS" "ZAR" "SSP" "SZL" "SEK" "CHF" "SYP" "THB" "TOP" "TTD" "AED" "TND" "UGX" "MKD" "EGP" "GBP" "TZS" "USD" "UYU" "UZS" "WST" "YER" "TWD" "UYW" "VES" "MRU" "STN" "CUC" "ZWL" "BYN" "TMT" "GHS" "SDG" "UYI" "RSD" "MZN" "AZN" "RON" "CHE" "CHW" "TRY" "XAF" "XCD" "XOF" "XPF" "XBA" "XBB" "XBC" "XBD" "XAU" "XDR" "XAG" "XPT" "XTS" "XPD" "XUA" "ZMW" "SRD" "MGA" "COU" "AFN" "TJS" "AOA" "BGN" "CDF" "BAM" "EUR" "MXV" "UAH" "GEL" "BOV" "PLN" "BRL" "CLF" "XSU" "USN" currency code
accountId required	string[0-9]+ identifier for the subaccount
merchantId required	string[0-9]+ identifier for the merchant
portalId required	string[0-9]+ identifier for the portal
userId	string[0-9]+ identifier for the user
mode required	string Enum: "live" "test" execution mode
paymentMethods	Array of strings Items Enum: "visa" "mastercard" "amex" "jcb" "wechat" "paypal" "sofort" "paydirekt" "postfinance-e" "postfinance-card" "bancontact" "przelewy24" "alipay" "ideal" "eps" "giropay" "sepa" list of available payment methods
expiration	string <date> link expiration date, the link will only be executable until end of that day
description	string [ 0 .. 255 ] characters free format description of the payment
reference required	string[0-9a-zA-Z.\\-_/]{1,20} payment reference number, has to be unique per merchant and mode
	object (AddressDataDto)
	object (AddressDataDto)
required	Array of objects (CartItemDto) [ 1 .. 400 ] items
language	string Enum: "de_DE" "en_US" link ISO language code
logo	string <url> logo url
backgroundImage	string <css> backgroundImage css property
active	boolean Default: true link activation status
successUrl	string final redirect after a successful payment
errorUrl	string final redirect after a final payment
backUrl	string URL for Back or Cancel
notifyUrl	string Url where the notification will be send after link was executed
email	string [ 4 .. 254 ] characters email the invoice should be delivered to
	object (InvoiceInformationDto) relevant information for the invoice module

Responses

Request samples

Payload

Content type

application/json

{"intent": "authorization",
"currency": "EUR",
"accountId": "12345",
"merchantId": "12345",
"portalId": "1234567",
"userId": "12345678",
"mode": "live",
"paymentMethods": ["visa",
"mastercard"
],
"expiration": "2020-02-20",
"description": "This payment is awesome!!",
"reference": "payment_1",
"shipping": {"firstName": "John",
"lastName": "Doe",
"company": "PAYONE GmbH",
"street": "Fraunhoferstr. 2-4",
"addressAddition": "7th floor",
"zip": "24118",
"city": "Kiel",
"state": "st",
"country": "DE"
},
"billing": {"firstName": "John",
"lastName": "Doe",
"company": "PAYONE GmbH",
"street": "Fraunhoferstr. 2-4",
"addressAddition": "7th floor",
"zip": "24118",
"city": "Kiel",
"state": "st",
"country": "DE"
},
"shoppingCart": [{"type": "goods",
"number": "73883HFJ",
"price": 1999,
"quantity": 1,
"description": "Potatoes",
"vatRate": 20,
"deliveryDateStart": "2021-01-01",
"deliveryDateEnd": "2021-01-01"
}
],
"language": "en_US",
"logo": "https://www.payone.com/wp-content/uploads/2018/12/Payone-Logo-2020.jpg",
"backgroundImage": "linear-gradient(to bottom right, #ffffff, #3295d6)",
"active": true,
"successUrl": "string",
"errorUrl": "string",
"backUrl": "string",
"notifyUrl": "string",
"email": "string",
"invoiceInformation": {"invoiceId": "string",
"invoiceText": "string"
}
}

Response samples

Content type

application/json

{"id": "HUENJ5FY124QHUENJ5FY124QHUENJ5FY",
"currency": "EUR",
"amount": 799,
"created": 0,
"modified": 0,
"intent": "authorization",
"paymentMethods": ["visa",
"mastercard"
],
"status": "ready",
"expiration": "2020-02-20",
"description": "This payment is awesome!!",
"reference": "payment_1",
"hash": "a42847abb8bfca62876ca64c0fa981f8",
"redirectUrl": "string",
"notifyUrl": "string",
"paymentProcess": "347867997",
"userId": "356845874",
"paymentMethod": "visa",
"shipping": {"firstName": "John",
"lastName": "Doe",
"company": "PAYONE GmbH",
"street": "Fraunhoferstr. 2-4",
"addressAddition": "7th floor",
"zip": "24118",
"city": "Kiel",
"state": "st",
"country": "DE"
},
"billing": {"firstName": "John",
"lastName": "Doe",
"company": "PAYONE GmbH",
"street": "Fraunhoferstr. 2-4",
"addressAddition": "7th floor",
"zip": "24118",
"city": "Kiel",
"state": "st",
"country": "DE"
},
"shoppingCart": [{"type": "goods",
"number": "73883HFJ",
"price": 1999,
"quantity": 1,
"description": "Potatoes",
"vatRate": 20,
"deliveryDateStart": "2021-01-01",
"deliveryDateEnd": "2021-01-01"
}
],
"language": "en_US",
"logo": "https://www.payone.com/wp-content/uploads/2018/12/Payone-Logo-2020.jpg",
"backgroundImage": "linear-gradient(to bottom right, #ffffff, #3295d6)",
"accountId": "12345",
"merchantId": "12345",
"portalId": "1234567",
"mode": "live",
"active": true,
"successUrl": "string",
"errorUrl": "string",
"backUrl": "string",
"email": "string",
"invoiceInformation": {"invoiceId": "string",
"invoiceText": "string"
},
"link": "string"
}

Get payment link by id.

Authorizations:

getSingleAuth

path Parameters

linkId

required

string[0N1RWU4X6F8Z9ALBQC3EG5HJKM2PS7TVDY]{32}

Responses

Response samples

Content type

application/json

{"id": "HUENJ5FY124QHUENJ5FY124QHUENJ5FY",
"currency": "EUR",
"amount": 799,
"created": 0,
"modified": 0,
"intent": "authorization",
"paymentMethods": ["visa",
"mastercard"
],
"status": "ready",
"expiration": "2020-02-20",
"description": "This payment is awesome!!",
"reference": "payment_1",
"hash": "a42847abb8bfca62876ca64c0fa981f8",
"redirectUrl": "string",
"notifyUrl": "string",
"paymentProcess": "347867997",
"userId": "356845874",
"paymentMethod": "visa",
"shipping": {"firstName": "John",
"lastName": "Doe",
"company": "PAYONE GmbH",
"street": "Fraunhoferstr. 2-4",
"addressAddition": "7th floor",
"zip": "24118",
"city": "Kiel",
"state": "st",
"country": "DE"
},
"billing": {"firstName": "John",
"lastName": "Doe",
"company": "PAYONE GmbH",
"street": "Fraunhoferstr. 2-4",
"addressAddition": "7th floor",
"zip": "24118",
"city": "Kiel",
"state": "st",
"country": "DE"
},
"shoppingCart": [{"type": "goods",
"number": "73883HFJ",
"price": 1999,
"quantity": 1,
"description": "Potatoes",
"vatRate": 20,
"deliveryDateStart": "2021-01-01",
"deliveryDateEnd": "2021-01-01"
}
],
"language": "en_US",
"logo": "https://www.payone.com/wp-content/uploads/2018/12/Payone-Logo-2020.jpg",
"backgroundImage": "linear-gradient(to bottom right, #ffffff, #3295d6)",
"accountId": "12345",
"merchantId": "12345",
"portalId": "1234567",
"mode": "live",
"active": true,
"successUrl": "string",
"errorUrl": "string",
"backUrl": "string",
"email": "string",
"invoiceInformation": {"invoiceId": "string",
"invoiceText": "string"
},
"link": "string"
}

Update a payment link.

Authorizations:

createAuth

path Parameters

linkId

required

string[0N1RWU4X6F8Z9ALBQC3EG5HJKM2PS7TVDY]{32}

Request Body schema: application/json

intent	string Default: "authorization" Enum: "authorization" "preauthorization" designates the type of transaction that will be created
currency required	string = 3 characters Enum: "ALL" "DZD" "ARS" "AUD" "BSD" "BHD" "BDT" "AMD" "BBD" "BMD" "BTN" "BOB" "BWP" "BZD" "SBD" "BND" "MMK" "BIF" "KHR" "CAD" "CVE" "KYD" "LKR" "CLP" "CNY" "COP" "KMF" "CRC" "HRK" "CUP" "CZK" "DKK" "DOP" "SVC" "ETB" "ERN" "FKP" "FJD" "DJF" "GMD" "GIP" "GTQ" "GNF" "GYD" "HTG" "HNL" "HKD" "HUF" "ISK" "INR" "IDR" "IRR" "IQD" "ILS" "JMD" "JPY" "KZT" "JOD" "KES" "KPW" "KRW" "KWD" "KGS" "LAK" "LBP" "LSL" "LRD" "LYD" "MOP" "MWK" "MYR" "MVR" "MUR" "MXN" "MNT" "MDL" "MAD" "OMR" "NAD" "NPR" "ANG" "AWG" "VUV" "NZD" "NIO" "NGN" "NOK" "PKR" "PAB" "PGK" "PYG" "PEN" "PHP" "QAR" "RUB" "RWF" "SHP" "SAR" "SCR" "SLL" "SGD" "VND" "SOS" "ZAR" "SSP" "SZL" "SEK" "CHF" "SYP" "THB" "TOP" "TTD" "AED" "TND" "UGX" "MKD" "EGP" "GBP" "TZS" "USD" "UYU" "UZS" "WST" "YER" "TWD" "UYW" "VES" "MRU" "STN" "CUC" "ZWL" "BYN" "TMT" "GHS" "SDG" "UYI" "RSD" "MZN" "AZN" "RON" "CHE" "CHW" "TRY" "XAF" "XCD" "XOF" "XPF" "XBA" "XBB" "XBC" "XBD" "XAU" "XDR" "XAG" "XPT" "XTS" "XPD" "XUA" "ZMW" "SRD" "MGA" "COU" "AFN" "TJS" "AOA" "BGN" "CDF" "BAM" "EUR" "MXV" "UAH" "GEL" "BOV" "PLN" "BRL" "CLF" "XSU" "USN" currency code
accountId required	string[0-9]+ identifier for the subaccount
merchantId required	string[0-9]+ identifier for the merchant
portalId required	string[0-9]+ identifier for the portal
userId	string[0-9]+ identifier for the user
mode required	string Enum: "live" "test" execution mode
paymentMethods	Array of strings Items Enum: "visa" "mastercard" "amex" "jcb" "wechat" "paypal" "sofort" "paydirekt" "postfinance-e" "postfinance-card" "bancontact" "przelewy24" "alipay" "ideal" "eps" "giropay" "sepa" list of available payment methods
expiration	string <date> link expiration date, the link will only be executable until end of that day
description	string [ 0 .. 255 ] characters free format description of the payment
reference required	string[0-9a-zA-Z.\\-_/]{1,20} payment reference number, has to be unique per merchant and mode
	object (AddressDataDto)
	object (AddressDataDto)
required	Array of objects (CartItemDto) [ 1 .. 400 ] items
language	string Enum: "de_DE" "en_US" link ISO language code
logo	string <url> logo url
backgroundImage	string <css> backgroundImage css property
active	boolean Default: true link activation status
successUrl	string final redirect after a successful payment
errorUrl	string final redirect after a final payment
backUrl	string URL for Back or Cancel
notifyUrl	string Url where the notification will be send after link was executed
email	string [ 4 .. 254 ] characters email the invoice should be delivered to
	object (InvoiceInformationDto) relevant information for the invoice module

Responses

Request samples

Payload

Content type

application/json

{"intent": "authorization",
"currency": "EUR",
"accountId": "12345",
"merchantId": "12345",
"portalId": "1234567",
"userId": "12345678",
"mode": "live",
"paymentMethods": ["visa",
"mastercard"
],
"expiration": "2020-02-20",
"description": "This payment is awesome!!",
"reference": "payment_1",
"shipping": {"firstName": "John",
"lastName": "Doe",
"company": "PAYONE GmbH",
"street": "Fraunhoferstr. 2-4",
"addressAddition": "7th floor",
"zip": "24118",
"city": "Kiel",
"state": "st",
"country": "DE"
},
"billing": {"firstName": "John",
"lastName": "Doe",
"company": "PAYONE GmbH",
"street": "Fraunhoferstr. 2-4",
"addressAddition": "7th floor",
"zip": "24118",
"city": "Kiel",
"state": "st",
"country": "DE"
},
"shoppingCart": [{"type": "goods",
"number": "73883HFJ",
"price": 1999,
"quantity": 1,
"description": "Potatoes",
"vatRate": 20,
"deliveryDateStart": "2021-01-01",
"deliveryDateEnd": "2021-01-01"
}
],
"language": "en_US",
"logo": "https://www.payone.com/wp-content/uploads/2018/12/Payone-Logo-2020.jpg",
"backgroundImage": "linear-gradient(to bottom right, #ffffff, #3295d6)",
"active": true,
"successUrl": "string",
"errorUrl": "string",
"backUrl": "string",
"notifyUrl": "string",
"email": "string",
"invoiceInformation": {"invoiceId": "string",
"invoiceText": "string"
}
}

Response samples

Content type

application/json

{"id": "HUENJ5FY124QHUENJ5FY124QHUENJ5FY",
"currency": "EUR",
"amount": 799,
"created": 0,
"modified": 0,
"intent": "authorization",
"paymentMethods": ["visa",
"mastercard"
],
"status": "ready",
"expiration": "2020-02-20",
"description": "This payment is awesome!!",
"reference": "payment_1",
"hash": "a42847abb8bfca62876ca64c0fa981f8",
"redirectUrl": "string",
"notifyUrl": "string",
"paymentProcess": "347867997",
"userId": "356845874",
"paymentMethod": "visa",
"shipping": {"firstName": "John",
"lastName": "Doe",
"company": "PAYONE GmbH",
"street": "Fraunhoferstr. 2-4",
"addressAddition": "7th floor",
"zip": "24118",
"city": "Kiel",
"state": "st",
"country": "DE"
},
"billing": {"firstName": "John",
"lastName": "Doe",
"company": "PAYONE GmbH",
"street": "Fraunhoferstr. 2-4",
"addressAddition": "7th floor",
"zip": "24118",
"city": "Kiel",
"state": "st",
"country": "DE"
},
"shoppingCart": [{"type": "goods",
"number": "73883HFJ",
"price": 1999,
"quantity": 1,
"description": "Potatoes",
"vatRate": 20,
"deliveryDateStart": "2021-01-01",
"deliveryDateEnd": "2021-01-01"
}
],
"language": "en_US",
"logo": "https://www.payone.com/wp-content/uploads/2018/12/Payone-Logo-2020.jpg",
"backgroundImage": "linear-gradient(to bottom right, #ffffff, #3295d6)",
"accountId": "12345",
"merchantId": "12345",
"portalId": "1234567",
"mode": "live",
"active": true,
"successUrl": "string",
"errorUrl": "string",
"backUrl": "string",
"email": "string",
"invoiceInformation": {"invoiceId": "string",
"invoiceText": "string"
},
"link": "string"
}