Skip to main content

SafetyPay Create Disposition Request

usernamestringrequired

SOAP account username.

Example: username_SOAP
passwordstring<password>required

SOAP account password.

Example: password_SOAP
mtidstringrequired

Unique merchant transaction identifier.

Example: mtid_soap
amountnumber<double>required

Payment amount.

Example: 10
currencystringrequired

Three-letter ISO 4217 currency code.

Possible values: >= 3 characters and <= 3 characters

Example: USD
merchantclientidstringrequired

Customer identifier on the merchant side.

Example: customer1
okUrlstring<uri>required

URL used after successful payment authorization.

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

URL used after unsuccessful or cancelled authorization.

Example: https://www.paysafecard.com/nokURL
pnUrlstring<uri>required

Payment notification URL.

Example: https://www.paysafecard.com/pnURL
customerDetailstring

Customer identifier or customer detail value.

Example: customer_id
subIdstring

Reporting criterion used to classify the transaction.

Example: reporting_criteria
customerTakeoverData object

Customer account information used to simplify the customer journey and support payout processing.

registrationDatestring<date>

Customer registration date with the partner. This value is mandatory when a deposit is intended to support payouts to the customer.

Example: 1997-04-10
kycLevelstring

Customer KYC level with the partner. This value is mandatory when a deposit is intended to support payouts to the customer.

Possible values: [FULL, SIMPLE]

Example: FULL
countryIso2string

ISO alpha-2 country of customer registration. This value is mandatory when a deposit is intended to support payouts to the customer.

Possible values: >= 2 characters and <= 2 characters

Example: MX
hashstring

Hash key used to transfer the customer details securely.

Example: 123%asd
dispositionRestrictions object[]

Restrictions applied to the SafetyPay disposition.

  • Array [
    • keystringrequired

    Type of restriction applied to the transaction.

    Possible values: [INSTRUMENT, INSTRUMENT_SUBTYPE, BANK_IDS]

    Example: INSTRUMENT
    valuestringrequired

    Value assigned to the selected restriction.

    Supported values include:

    • INSTRUMENT: paysafecard, safetypay
    • INSTRUMENT_SUBTYPE: cash, online
    • BANK_IDS: comma-separated supported bank IDs
    Example: safetypay
  • ]
    • SafetyPay Create Disposition Request
    {
      "username": "username_SOAP",
      "password": "password_SOAP",
      "mtid": "mtid_soap",
      "amount": 10,
      "currency": "USD",
      "merchantclientid": "customer1",
      "okUrl": "https://www.paysafecard.com/okURL",
      "nokUrl": "https://www.paysafecard.com/nokURL",
      "pnUrl": "https://www.paysafecard.com/pnURL",
      "customerDetail": "customer_id",
      "subId": "reporting_criteria",
      "customerTakeoverData": {
        "registrationDate": "1997-04-10",
        "kycLevel": "FULL",
        "countryIso2": "MX",
        "hash": "123%asd"
      },
      "dispositionRestrictions": [
        {
          "key": "INSTRUMENT",
          "value": "safetypay"
        }
      ]
    }