Skip to main content

SafetyPay Payout Validation Request

typestringrequired

Product type. Must be set to PAYSAFECARD.

Possible values: [PAYSAFECARD]

Example: PAYSAFECARD
payout_instrumentstringrequired

Payout instrument. Must be set to SAFETYPAY.

Possible values: [SAFETYPAY]

Example: SAFETYPAY
capturebooleanrequired

Determines whether the request validates or executes the payout.

Set to false to validate the payout. Set to true to execute the payout immediately.

Possible values: [false, true]

Example: false
amountnumber<double>required

Payout amount. The source permits up to 11 digits before the decimal point and up to two digits after it.

Example: 1000
currencystringrequired

Three-letter ISO 4217 currency code.

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

Example: MXN
country_codestringrequired

Country of the payout beneficiary.

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

Example: MX
customer objectrequired
idstringrequired

Unique customer identifier in the merchant system.

Possible values: <= 60 characters

Example: uniquecustomerid
emailstring<email>

Customer email address.

The email address is required when a psc_id is not provided.

Example: valid@email.com
date_of_birthstring<date>required

Customer date of birth.

Example: 1996-10-20
first_namestringrequired

Customer first name.

Possible values: <= 60 characters

Example: Max
middle_namestring

Customer middle name.

Possible values: <= 60 characters

Example: Diego
last_namestringrequired

Customer last name.

Possible values: <= 60 characters

Example: Power
phone_numberstring

Customer phone number in ITU-T E.164-compatible format.

Possible values: <= 20 characters

Example: +525516690627
ip_addressstring

Customer IP address.

Example: 123.456.123.456
account_createdstring

Customer account creation value supplied by the merchant.

Example: 2021
countrystring

Customer country code.

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

Example: MX
kyc_levelstring

Customer KYC level.

Example: FULL
ipstring

Customer IP address used in the payout request.

Example: 13.248.166.223
bank_account objectrequired
typestringrequired

Type of beneficiary bank account. Refer to the SafetyPay code books for supported values.

Possible values: <= 12 characters

Example: CLABE
numberstringrequired

Beneficiary bank-account number.

Possible values: <= 50 characters

Example: 123456789034567896
bank_id_codestring

Bank identifier returned by the Retrieve Banks operation.

This field is mandatory for Chile and Peru.

Possible values: <= 4 characters

Example: 0003
id_document objectrequired
typestringrequired

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

Possible values: <= 3 characters

Example: RFC
numberstringrequired

Customer identification-document number.

Possible values: <= 50 characters

Example: HEGJ820506M10
submerchant_idstring

Sub-merchant identifier, also known as the reporting criterion.

This field is optional except for payment service providers.

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

Example: RCxD1234
notification_urlstring<uri>

Notification URL contacted after the status of the payout changes.

Example: https://notification.com/webhook
descriptionstring

Description of the payout transaction.

Possible values: <= 120 characters

Example: Winnings payout
SafetyPay Payout Validation Request
{
  "type": "PAYSAFECARD",
  "payout_instrument": "SAFETYPAY",
  "capture": false,
  "amount": 1000,
  "currency": "MXN",
  "country_code": "MX",
  "customer": {
    "id": "uniquecustomerid",
    "email": "valid@email.com",
    "date_of_birth": "1996-10-20",
    "first_name": "Max",
    "middle_name": "Diego",
    "last_name": "Power",
    "phone_number": "+525516690627",
    "ip_address": "123.456.123.456",
    "account_created": "2021",
    "country": "MX",
    "kyc_level": "FULL",
    "ip": "13.248.166.223"
  },
  "bank_account": {
    "type": "CLABE",
    "number": "123456789034567896"
  },
  "bank_id_code": "0003",
  "id_document": {
    "type": "RFC",
    "number": "HEGJ820506M10"
  },
  "submerchant_id": "RCxD1234",
  "notification_url": "https://notification.com/webhook",
  "description": "Winnings payout"
}