Payrexx Octri Demo
POST/Gateway/

Create a payment gateway

Creates a payment gateway using the supplied payment configuration. Provide amount and currency; use basket when you need to describe products, with item amounts matching the gateway amount. A 200 response returns the created gateway details and payment link.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

31 body fields

Payment gateway configuration. amount and currency are required.

amountintegerrequired
Amount of payment in cents.
applicationFeeintegeroptional
Amount in the smallest unit of the currency.
basketarray<object>optional
List of all products (incl. shipping costs). The sum of all product amounts must match the amount parameter above. Basket products contains name, description, quantity, amount (in cents) and vatRate (in Percent).
buttonTextarray<string>optional
Change the default button Text "Pay" to a custom String
cancelRedirectUrlstringoptional
URL to redirect to after manual cancellation by shopper.
chargeOnAuthorizationbooleanoptional
preAuthorization needs to be "true". This will charge the authorization during the first payment.
Default:false
concardisOrderIdstringoptional
Only available for Concardis PSP and if the custom ORDERID option is activated in PSP settings in Payrexx administration. This ORDERID will be transferred to the Payengine.
currencystringrequired
Currency of payment (ISO code).
failedRedirectUrlstringoptional
URL to redirect to after failed payment.
fieldsobjectoptional
The contact data fields which should be stored along with payment
isPriceExclusiveVatbooleanoptional
if set to true the vat will be added on top of amount
languagestringoptional
The language ISO code by ISO 639-1.
lookAndFeelProfilestringoptional
UUID of the look and feel profile to use.
pmarray<string>optional
List of payment mean names to display
preAuthorizationbooleanoptional
Whether charge payment manually at a later date (type authorization)
Default:false
psparray<integer>optional
List of PSPs to provide for payment. If empty all available PSPs are provied.
purposestringoptional
The purpose of the payment.
qrCodeSessionIdstringoptional
Holds the session ID of a scanned QR code. Only available and needed for Static QR Code with Twint.
referenceIdstringoptional
An internal reference id used by your system.
reservationbooleanoptional
Whether charge payment manually at a later date (type reservation)
Default:false
reserveOnAuthorizationbooleanoptional
preAuthorization needs to be "true". This will create a reservation based on an authorization during the first payment.
skipResultPagebooleanoptional
Skip result page and directly redirect to success or failed URL
Default:false
skustringoptional
Product stock keeping unit
subscriptionCancellationIntervalstringoptional
Defines the period, in which a subscription can be canceled.
subscriptionIntervalstringoptional
Payment interval
subscriptionPeriodstringoptional
Duration of the subscription
subscriptionStatebooleanoptional
Defines whether the payment should be handled as subscription.
Default:false
successMessagestringoptional
Custom success message on result page.
successRedirectUrlstringoptional
URL to redirect to after successful payment.
validityintegeroptional
Gateway validity in minutes.
vatRatenumberoptional
VAT Rate Percentage
Default:null

3 status codes
200Returns the created gateway data, including its amount, currency, identifier, payment link, and payment configuration.
dataarray<object>optional
statusstringoptional
400Returned when a required field is missing or a supplied value fails validation.
errorobjectoptional
messagestringoptional
reasonstringoptional
statusstringoptional
404Returned when a referenced resource cannot be found.
errorobjectoptional
messagestringoptional
reasonstringoptional
statusstringoptional

Error handling

A 400 is returned when a required field is missing or a supplied value is invalid. amount and currency are required. A 404 is returned when a referenced resource cannot be found.