Create a VR pay secure Gateway

post http://api.vr-pay-secure.de/v1.0/Gateway/

📘
Using the PHP client library
If you are using our PHP client library, there are setter and getter methods to access the PHP object properties.

📘
Integration manual
For more information about the usage of VR pay secure Gateway, please visit VR pay secure Gateway section.

Query Params

instance

string

required

Your VR pay secure instance name

Body Params

amount

int32

required

Amount of payment.

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 strings

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 and amount (in cents).

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.

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

string

The contact data fields which should be stored along with payment

skipResultPage

boolean

Defaults to false

Skip result page and directly redirect to success or failed URL

chargeOnAuthorization

boolean

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

validity

int32

Gateway validity in minutes.

subscriptionState

boolean

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.

Response

Language

Request


xxxxxxxxxx
15
1
apiSignature=`echo -n "amount=8925&currency=CHF&preAuthorization=0&referenceId=975382&fields%5Bforename%5D%5Bvalue%5D=Max&fields%5Bsurname%5D%5Bvalue%5D=Mustermann&fields%5Bemail%5D%5Bvalue%5D=max.mustermann%40mysite.com&successRedirectUrl=https%3A%2F%2Fwww.merchant-website.com%2Fsuccess&failedRedirectUrl=https%3A%2F%2Fwww.merchant-website.com%2Ffailed" | openssl dgst -sha256 -hmac "INSTANCE_API_SECRET" -binary | openssl enc -base64`
2
curl --request POST "https://api.vr-pay-secure.de/v1.0/Gateway/?instance=INSTANCE_NAME" \
3
  --data-urlencode "amount=8925" \
4
  --data-urlencode "vatRate=7.7" \
5
  --data-urlencode "currency=CHF" \
6
  --data-urlencode "sku=P01122000" \
7
  --data-urlencode "preAuthorization=0" \
8
  --data-urlencode "reservation=0" \
9
  --data-urlencode "referenceId=975382" \
10
  --data-urlencode "fields[forename][value]=Max" \
11
  --data-urlencode "fields[surname][value]=Mustermann" \
12
  --data-urlencode "fields[email][value]=max.mustermann@mysite.com" \
13
  --data-urlencode "successRedirectUrl=https://www.merchant-website.com/success" \
14
  --data-urlencode "failedRedirectUrl=https://www.merchant-website.com/failed" \
15
  --data-urlencode "ApiSignature=$apiSignature"

Choose an example:

application/json

Create a VR pay secure Gateway

📘
Using the PHP client library

📘
Integration manual

📘Using the PHP client library

📘Integration manual

200200

📘
Using the PHP client library

📘
Integration manual