Create a Gateway

post

https://api.payrexx.com/v1.14/Gateway/

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

instance

string

required

Your Payrexx instance name

Body Params

amount

int32

required

Amount of payment in cents.

vatRate

float

Defaults to null

VAT Rate Percentage

currency

string

required

Currency of payment (ISO code).

sku

string

Product stock keeping unit

purpose

string

The purpose of the payment.

successRedirectUrl

string

URL to redirect to after successful payment.

failedRedirectUrl

string

URL to redirect to after failed payment.

cancelRedirectUrl

string

URL to redirect to after manual cancellation by shopper.

basket

array of objects

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).

basket

psp

array of int32s

List of PSPs to provide for payment. If empty all available PSPs are provied.

psp

array of strings

List of payment mean names to display

preAuthorization

boolean

Defaults to false

Whether charge payment manually at a later date (type authorization)

reservation

boolean

Defaults to false

Whether charge payment manually at a later date (type reservation)

referenceId

string

An internal reference id used by your system.

fields

object

The contact data fields which should be stored along with payment

language

string

The language ISO code by ISO 639-1.

concardisOrderId

string

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.

skipResultPage

boolean

Defaults to false

Skip result page and directly redirect to success or failed URL

chargeOnAuthorization

boolean

Defaults to false

preAuthorization needs to be "true". This will charge the authorization during the first payment.

validity

int32

Gateway validity in minutes.

subscriptionState

boolean

Defaults to false

Defines whether the payment should be handled as subscription.

subscriptionInterval

string

Payment interval

subscriptionPeriod

string

Duration of the subscription

subscriptionCancellationInterval

string

Defines the period, in which a subscription can be canceled.

buttonText

array of strings

Change the default button Text "Pay" to a custom String

buttonText

lookAndFeelProfile

string

UUID of the look and feel profile to use.

successMessage

string

Custom success message on result page.

qrCodeSessionId

string

Holds the session ID of a scanned QR code. Only available and needed for Static QR Code with Twint.

applicationFee

int32

Amount in the smallest unit of the currency.

reserveOnAuthorization

boolean

preAuthorization needs to be "true". This will create a reservation based on an authorization during the first payment.

isPriceExclusiveVat

boolean

if set to true the vat will be added on top of amount

Responses

200200

400Bad Request

404Not Found