Sign in

v1

latestOpenAPI 3.0.12026-07-144816.3 KB
Link Management

Update a payment link.

put/v1/payment-links/{linkId}

Path parameters

linkIdstring required

Request body

accountIdstring required

identifier for the subaccount

activeboolean

link activation status

backgroundImagestring css

backgroundImage css property

currency'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' required

currency code

descriptionstring

free format description of the payment

emailstring

email the invoice should be delivered to

errorUrlstring

final redirect after a final payment

expirationstring date

link expiration date, the link will only be executable until end of that day

intent'authorization' | 'preauthorization'

designates the type of transaction that will be created

language'de_DE' | 'en_US'

link ISO language code

logostring url

logo url

merchantIdstring required

identifier for the merchant

mode'live' | 'test' required

execution mode

notifyUrlstring

Url where the notification will be send after link was executed

paymentMethodsstring[]

list of available payment methods

portalIdstring required

identifier for the portal

referencestring required

payment reference number, has to be unique per merchant and mode

successUrlstring

final redirect after a successful payment

userIdstring

identifier for the user

Example request

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

Response

default response

accountIdstring

identifier for the subaccount

activeboolean

link activation status

amountinteger

total amount of all shopping cart items in lowest denomination

backgroundImagestring css

backgroundImage css property

createdinteger

created time in ISO 8601 format

currency'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

descriptionstring

free format description of the payment

emailstring

customer email for invoices or payment notification

errorUrlstring

final redirect after a failed payment

expirationstring date

link expiration date, the link will only be executable until end of that day

hashstring

hash for the client API

idstring

link id

intent'authorization' | 'preauthorization'

designates the type of transaction that will be created

language'de_DE' | 'en_US'

link ISO language code

linkstring

customer payment link

logostring url

logo url

merchantIdstring

identifier for the merchant

mode'live' | 'test'

execution mode

modifiedinteger

last modified time in ISO 8601 format

notifyUrlstring

notify url. If unset no notification will be send

paymentMethod'visa' | 'mastercard' | 'amex' | 'paypal' | 'sofort' | 'paydirekt' | 'postfinance-e' | 'postfinance-card' | 'bancontact' | 'przelewy24' | 'alipay' | 'ideal' | 'eps' | 'giropay' | 'sepa'

available payment methods

paymentMethodsstring[]

list of available payment methods

paymentProcessstring

identifier of the created payment process.

portalIdstring

identifier for the portal

redirectUrlstring

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

referencestring

payment reference number, has to be unique per merchant and mode

status'ready' | 'created' | 'executed' | 'expired' | 'deactivated'

link status

successUrlstring

final redirect after a successful payment

userIdstring

identifier of the created user.

Example response

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