SafetyPay SOAP Payout Validation Request

usernamestringrequired

Business partner account username provided by PaysafeCard for authentication.

Example: USER

passwordstring<password>required

Business partner account password provided by PaysafeCard for authentication.

Example: PASSWORD

ptidstringrequired

Unique payout transaction identifier.

The value must remain unique even when a transaction fails and must differ from any mtid used during a payment. A value of up to 20 characters is recommended.

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

Example: abcd12345678efgh

subIdstring

Reporting criterion used to classify transactions.

This parameter is mandatory for payment service providers. Leave the value empty when no other value has been agreed with PaysafeCard. The value is case-sensitive.

Possible values: <= 8 characters

Example: shop1

amountnumber<double>required

Payout amount.

The amount must not exceed 2500.00 EUR or its equivalent in the transaction currency. Use a period as the decimal separator, with up to 11 digits before and exactly two digits after the decimal point. Thousands separators are not supported.

Possible values: <= 2500

Example: 1234.56

currencystringrequired

Three-letter uppercase ISO 4217 payout currency code.

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

Example: MXN

merchantClientIdstringrequired

Unique customer identifier provided by the merchant.

When required, the value must match the merchantClientId used during a previous deposit.

Possible values: <= 200 characters

Example: unique-mcid-1

clientIpstring

Optional IP address of the customer.

Example: 123.45.67.89

countryCodestringrequired

Two-letter ISO 3166-1 alpha-2 country code.

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

Example: MX

payoutInstrumentstringrequired

Payout instrument. Must always be SAFETYPAY.

Possible values: [SAFETYPAY]

Example: SAFETYPAY

validationOnlybooleanrequired

Determines whether the payout is validated or executed.

Set to true to validate the payout. Set to false to capture it.

utcOffsetstringrequired

Difference in hours and minutes from Coordinated Universal Time.

Possible values: Value must match regular expression ^[+-][0-9]{2}:[0-9]{2}$

Example: +09:00

notificationUrlstring<uri>

Optional URL to which PaysafeCard sends a notification after the payout is finalized, successfully or unsuccessfully.

Example: https://www.merchantsite.com/transaction/abcd12345678efgh/notification

customerDetailsBasic objectrequired

firstNamestringrequired

First name of the payout customer.

Possible values: <= 60 characters

Example: John

middleNamestring

Optional middle name of the payout customer.

Possible values: <= 60 characters

Example: William

lastNamestringrequired

Last name of the payout customer.

Possible values: <= 60 characters

Example: Doe

dateOfBirthstring<date>required

Date of birth of the payout customer in YYYY-MM-DD format.

Example: 1999-12-31

phoneNumberstring

Optional phone number of the payout customer.

Possible values: <= 20 characters

Example: +527729871234

emailstring<email>

Optional email address of the payout customer.

Possible values: <= 255 characters

Example: joh.wdoe@customer.com

registrationDatestring<date>required

Customer account creation date with the merchant.

Example: 2021-12-12

countrystringrequired

Country of the customer.

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

Example: PT

kycLevelstringrequired

Customer KYC status with the merchant.

Possible values: [SIMPLE, FULL]

Example: SIMPLE

bankAccount objectrequired

typestringrequired

Type of customer bank account. Refer to the SafetyPay code books.

Example: CLABE

numberstringrequired

Customer bank-account number.

Possible values: <= 50 characters

Example: 012345678910111216

bankIdCodestring

Bank identifier returned by the getPayoutBanks request.

This parameter is mandatory for Chile and Peru.

Example: 0003

idDocument objectrequired

typestringrequired

Type of customer identification document. Refer to the SafetyPay code books.

Example: RFC

numberstringrequired

Customer identification-document number.

Possible values: <= 50 characters

Example: XXAX010101000

descriptionstring

Description of the payout transaction.

Example: description

SafetyPay SOAP Payout Validation Request

{
  "username": "USER",
  "password": "PASSWORD",
  "ptid": "abcd12345678efgh",
  "subId": "shop1",
  "amount": 1234.56,
  "currency": "MXN",
  "merchantClientId": "unique-mcid-1",
  "clientIp": "123.45.67.89",
  "countryCode": "MX",
  "payoutInstrument": "SAFETYPAY",
  "validationOnly": true,
  "utcOffset": "+09:00",
  "notificationUrl": "https://www.merchantsite.com/transaction/abcd12345678efgh/notification",
  "customerDetailsBasic": {
    "firstName": "John",
    "middleName": "William",
    "lastName": "Doe",
    "dateOfBirth": "1999-12-31",
    "phoneNumber": "+527729871234",
    "email": "joh.wdoe@customer.com",
    "registrationDate": "2021-12-12",
    "country": "PT",
    "kycLevel": "SIMPLE"
  },
  "bankAccount": {
    "type": "CLABE",
    "number": "012345678910111216"
  },
  "bankIdCode": "0003",
  "idDocument": {
    "type": "RFC",
    "number": "XXAX010101000"
  },
  "description": "description"
}