Skip to main content

SafetyPay Payout Response

objectstring

Type of object. Always payout.

Possible values: [payout]

Example: payout
idstring

Unique payout identifier.

Example: out_1000067708_FfCOjVmv2r9qFncnOStiCTYI6yDiAPDr_MXN
createdinteger<int64>

Unix timestamp indicating when the payout was created.

Example: 1699533982066
updatedinteger<int64>

Unix timestamp indicating when the payout was updated.

Example: 1699533982075
currencystring

Payout currency.

Example: MXN
customer object
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
statusstring

Current payout status.

Example: VALIDATION_SUCCESSFUL
descriptionstring

Additional information or comments about the payout.

Example: Winnings payout
amountnumber<double>

Payout amount.

Example: 1000
payout_instrumentstring

Payout instrument.

Possible values: [SAFETYPAY]

Example: SAFETYPAY
country_codestring

Country of the payout beneficiary.

Example: MX
bank_account object
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

Identifier of the bank used for the payout.

This field is mandatory for Peru and Chile.

Possible values: <= 4 characters

Example: 6453
id_document object
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
notification_urlstring<uri>

Notification URL contacted after the payout status changes.

Example: https://notification.com/webhook
SafetyPay Payout Response
{
  "object": "payout",
  "id": "out_1000067708_FfCOjVmv2r9qFncnOStiCTYI6yDiAPDr_MXN",
  "created": 1699533982066,
  "updated": 1699533982075,
  "currency": "MXN",
  "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"
  },
  "status": "VALIDATION_SUCCESSFUL",
  "description": "Winnings payout",
  "amount": 1000,
  "payout_instrument": "SAFETYPAY",
  "country_code": "MX",
  "bank_account": {
    "type": "CLABE",
    "number": "123456789034567896"
  },
  "bank_id_code": "6453",
  "id_document": {
    "type": "RFC",
    "number": "HEGJ820506M10"
  },
  "notification_url": "https://notification.com/webhook"
}