PAYONE Link-API

To create and manage PAYONE Links we provide the following API. If you want to learn more about how to authenticate on our API read detailed instructions here: Authorization

Servers

https://onelink.pay1.de/api - PAYONE Link API server url

Link Management

Endpoints intended for server-to-server communication.

SchemasĀ 

AddressDataDto
{
firstName   string
maxLength: 50
minLength: 1
example: John
customer first name

lastName    string
maxLength: 50
minLength: 2
example: Doe
customer last name

company string
maxLength: 50
minLength: 2
example: PAYONE GmbH
customer company name

street  string
maxLength: 50
minLength: 2
example: Fraunhoferstr. 2-4
customer street name

addressAddition string
maxLength: 50
minLength: 1
example: 7th floor
customer additional address line

zip string
maxLength: 10
minLength: 2
pattern: [0-9A-Za-z_.\-/ ]{2,10}
example: 24118
customer postcode

city    string
maxLength: 50
minLength: 1
pattern: ^[^\u0000\\!=<>?+;"*\d]+$
example: Kiel
customer city

state   string
maxLength: 2
minLength: 2
pattern: [A-Z]{2}
customer state code

country string
maxLength: 2
minLength: 2
pattern: [A-Z]{2}
example: DE
customer country code (2 letter ISO-3166 code)

}

---end

CardItemDto
{
type*   string
example: goods
item type

Enum:
[ goods, shipment, handling, voucher ]
number* string
maxLength: 32
minLength: 1
pattern: [0-9A-Za-z(){} +\-_#/:\[\]]{1,32}
example: 73883HFJ
item number

price*  integer($int64)
maximum: 1999999999
minimum: -1999999999
example: 1999
gross price of single item

quantity*   integer($int64)
maximum: 999999
minimum: 1
example: 1
total number of ordered items

description string
maxLength: 255
minLength: 1
example: Potatoes
item description

vatRate integer($int64)
maximum: 9999
minimum: 0
example: 20
vat rate (<100 in %, >=100 in bp)

deliveryDateStart   string($date)
example: 2021-01-01
delivery date

deliveryDateEnd string($date)
example: 2021-01-01
delivery period end date

}

InvoiceInformationDto
{
description:    
relevant information for the invoice module

invoiceId   string
maxLength: 20
minLength: 0
id that should be put on the invoice

invoiceText string
maxLength: 255
minLength: 0
short text that should be put after the invoice

}

LinkCreateRequest
{
description:    
a link create request

intent  string
default: authorization
designates the type of transaction that will be created

Enum:
[ authorization, preauthorization ]
currency*   string
maxLength: 3
minLength: 3
example: EUR
currency code

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 ]
accountId*  string
pattern: [0-9]+
example: 12345
identifier for the subaccount

merchantId* string
pattern: [0-9]+
example: 12345
identifier for the merchant

portalId*   string
pattern: [0-9]+
example: 1234567
identifier for the portal

userId  string
pattern: [0-9]+
example: 12345678
identifier for the user

mode*   string
example: live
execution mode

Enum:
[ live, test ]
paymentMethods  [
example: List [ "visa", "mastercard" ]
list of available payment methods

string
example: visa
available payment methods

Enum:
[ visa, mastercard, amex, jcb, wechat, paypal, sofort, paydirekt, postfinance-e, postfinance-card, bancontact, przelewy24, alipay, ideal, eps, giropay, sepa ]
]
expiration  string($date)
example: 2020-02-20
link expiration date, the link will only be executable until end of that day

description string
maxLength: 255
minLength: 0
example: This payment is awesome!!
free format description of the payment

reference*  string
pattern: [0-9a-zA-Z.\\-_/]{1,20}
example: payment_1
payment reference number, has to be unique per merchant and mode

customerId  string
pattern: [0-9a-zA-Z.\\-_/]{1,20}
example: 012ABC./-qwerty
identifier for the customer

shipping    AddressDataDto{...}
billing AddressDataDto{...}
shoppingCart*   [
maxItems: 400
minItems: 1
CartItemDto{...}]
language    string
example: en_US
link ISO language code

Enum:
[ de_DE, en_US, fr_FR, es_ES, pl_PL ]
logo    string($url)
example: https://www.payone.com/wp-content/uploads/2018/12/Payone-Logo-2020.jpg
logo url

backgroundImage string($css)
example: linear-gradient(to bottom right, #ffffff, #3295d6)
backgroundImage css property

active  boolean
example: true
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
maxLength: 254
minLength: 4
email the invoice should be delivered to

invoiceInformation  InvoiceInformationDto{...}
}

LinkResponse
{
id  string
maxLength: 32
minLength: 32
example: HUENJ5FY124QHUENJ5FY124QHUENJ5FY
link id

currency    string
maxLength: 3
minLength: 3
example: EUR
currency code

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 ]
amount  integer($int64)
maximum: 1999999999
minimum: 1
example: 799
total amount of all shopping cart items in lowest denomination

created integer($int64)
created time in ISO 8601 format

modified    integer($int64)
last modified time in ISO 8601 format

intent  string
default: authorization
designates the type of transaction that will be created

Enum:
[ authorization, preauthorization ]
paymentMethods  [
example: List [ "visa", "mastercard" ]
list of available payment methods

string
example: visa
available payment methods

Enum:
[ visa, mastercard, amex, jcb, wechat, paypal, sofort, paydirekt, postfinance-e, postfinance-card, bancontact, przelewy24, alipay, ideal, eps, giropay, sepa ]
]
status  string
example: ready
link status

Enum:
[ ready, created, executed, expired, deactivated ]
expiration  string($date)
example: 2020-02-20
link expiration date, the link will only be executable until end of that day

description string
maxLength: 255
example: This payment is awesome!!
free format description of the payment

reference   string
maxLength: 20
minLength: 1
example: payment_1
payment reference number, has to be unique per merchant and mode

hash    string
example: a42847abb8bfca62876ca64c0fa981f8
hash for the client API

redirectUrl string
redirect url. empty if the payment process does not require a redirect.

notifyUrl   string
notify url. If unset no notification will be send

paymentProcess  string
example: 347867997
identifier of the created payment process.

userId  string
example: 356845874
identifier of the created user.

paymentMethod   string
example: visa
available payment methods

Enum:
Array [ 17 ]
shipping    AddressDataDto{...}
billing AddressDataDto{...}
shoppingCart    [CartItemDto{...}]
language    string
example: en_US
link ISO language code

Enum:
[ de_DE, en_US, fr_FR, es_ES, pl_PL ]
logo    string($url)
example: https://www.payone.com/wp-content/uploads/2018/12/Payone-Logo-2020.jpg
logo url

backgroundImage string($css)
example: linear-gradient(to bottom right, #ffffff, #3295d6)
backgroundImage css property

accountId   string
example: 12345
identifier for the subaccount

merchantId  string
example: 12345
identifier for the merchant

portalId    string
example: 1234567
identifier for the portal

mode    string
example: live
execution mode

Enum:
[ live, test ]
active  boolean
example: true
default: true
link activation status

successUrl  string
final redirect after a successful payment

errorUrl    string
final redirect after a failed payment

backUrl string
URL for Back or Cancel

email   string
maxLength: 254
minLength: 4
customer email for invoices or payment notification

invoiceInformation  InvoiceInformationDto{...}
link    string
customer payment link

}

PageLinkResponse
{
totalPages  integer($int32)
totalElements   integer($int64)
size    integer($int32)
content [LinkResponse{...}]
number  integer($int32)
first   boolean
sort    Sort{
sorted  boolean
unsorted    boolean
empty   boolean
}
numberOfElements    integer($int32)
pageable    Pageable{
offset  integer($int64)
sort    Sort{
sorted  boolean
unsorted    boolean
empty   boolean
}
pageNumber  integer($int32)
pageSize    integer($int32)
unpaged boolean
paged   boolean
}
last    boolean
empty   boolean
}

Pageable
{
offset  integer($int64)
sort    Sort{
sorted  boolean
unsorted    boolean
empty   boolean
}
pageNumber  integer($int32)
pageSize    integer($int32)
unpaged boolean
paged   boolean
}

Sort
{
sorted  boolean
unsorted    boolean
empty   boolean
}
Download API Definition

---end