Skip to main content

CreateDispositionRequest

Request used to create a PaysafeCard disposition and initiate the payment process.

usernamestring

SOPG username provided by PaysafeCard.

Example: USER
passwordstring

SOPG password provided by PaysafeCard.

Example: PASSWORD
mtidstring

Merchant transaction ID. Unique identifier for the disposition.

Example: 18b02d230-a6822f-4cbb-aee9-0bc07d90cfa4
subIdstring

Optional reporting criteria value.

Example: shop1
amountstring

Transaction amount.

Example: 10.00
currencystring

Transaction currency in ISO 4217 format.

Example: EUR
okUrlstring<uri>

URL to which the customer is redirected after successful payment.

Example: https://ok.com
nokUrlstring<uri>

URL to which the customer is redirected after cancelling the payment.

Example: https://nok.com
merchantclientidstring

Customer identifier on the business partner side.

Example: cID_919191
pnUrlstring<uri>

Payment notification URL.

Example: https://notification.com/
clientIpstring

IP address of the PaysafeCard customer.

Example: 192.0.2.1
shopIdstring

Identifier of the shop that originated the request.

Possible values: <= 60 characters, Value must match regular expression ^[A-Za-z0-9_-]+$

Example: 2568-B415rh_785
shopLabelstring

Label or URL of the shop identified by shopId.

Possible values: <= 60 characters

Example: www.foodstore.com
dispositionRestrictions object[]

Optional restrictions for the payment transaction.

  • Array [
  • keystring

    Restriction key.

    Example: MIN_AGE
    valuestring

    Restriction value.

    Example: 18
  • ]
  • CreateDispositionRequest
    {
    "username": "USER",
    "password": "PASSWORD",
    "mtid": "18b02d230-a6822f-4cbb-aee9-0bc07d90cfa4",
    "subId": "shop1",
    "amount": "10.00",
    "currency": "EUR",
    "okUrl": "https://ok.com",
    "nokUrl": "https://nok.com",
    "merchantclientid": "cID_919191",
    "pnUrl": "https://notification.com/",
    "clientIp": "192.0.2.1",
    "shopId": "2568-B415rh_785",
    "shopLabel": "www.foodstore.com",
    "dispositionRestrictions": [
    {
    "key": "MIN_AGE",
    "value": "18"
    }
    ]
    }