{
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
}
|