Skip to main content

Create Disposition Request

Elements must be sent in the order defined below, as required by the PscService contract.

usernamestringrequired

SOPG username provided by paysafecard.

Example: username_SOAP
passwordstring<password>required

SOPG password provided by paysafecard.

Example: password_SOAP
mtidstringrequired

Merchant transaction ID. Unique identifier for the disposition.

Example: mtid_soap
subIdstring

Reporting criterion used to classify sub-merchants.

Can be repeated.

Example: reporting_criteria
amountnumber<double>required

Transaction amount.

The current minimum amount for gift card payments is 0.10 USD and the current maximum amount is 1000.00 USD.

Example: 10
currencystringrequired

Transaction currency in ISO 4217 format.

Possible values: >= 3 characters and <= 3 characters, Value must match regular expression ^[A-Z]{3}$

Example: USD
okUrlstring<uri>

URL to which the customer is redirected after successful payment.

Example: https://www.paysafecard.com/okURL
nokUrlstring<uri>

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

Example: https://www.paysafecard.com/nokURL
merchantclientidstring

Customer identifier on the business partner side.

Example: customer1
pnUrlstring<uri>

Payment notification URL.

Example: https://www.paysafecard.com/pnURL
dispositionRestrictions object[]

The payment restrictions array.

Can be repeated once per restriction.

  • Array [
    • keystringrequired

    Value to specify what type of restriction should be applied for the transaction.

    Possible values: [INSTRUMENT, INSTRUMENT_SUBTYPE]

    Example: INSTRUMENT
    valuestringrequired

    Value to define the available options for a certain restriction.

    For INSTRUMENT: paysafecard or giftcard.

    For INSTRUMENT_SUBTYPE: cvspharmacy, openbuckscard or dollargeneral.

    Example: giftcard
  • ]
    • customerDetailstring[]

    Customer details to be returned for the transaction.

    Can be repeated once per requested detail.

    Possible values: [CUSTOMER_ID, FIRST_NAME, LAST_NAME, DATE_OF_BIRTH, AGE, E_MAIL, KYC_LEVEL, CURRENCY]

    Example: ["CUSTOMER_ID"]
    Create Disposition Request
    {
      "username": "username_SOAP",
      "password": "password_SOAP",
      "mtid": "mtid_soap",
      "subId": "reporting_criteria",
      "amount": 10,
      "currency": "USD",
      "okUrl": "https://www.paysafecard.com/okURL",
      "nokUrl": "https://www.paysafecard.com/nokURL",
      "merchantclientid": "customer1",
      "pnUrl": "https://www.paysafecard.com/pnURL",
      "dispositionRestrictions": [
        {
          "key": "INSTRUMENT",
          "value": "giftcard"
        }
      ],
      "customerDetail": [
        "CUSTOMER_ID"
      ]
    }