Skip to main content
POST
/
payouts
/
validate
Validate Payout Parameters
curl --request POST \
  --url https://access.utgl.io/v1/payouts/validate \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountNumber": 6225888888888888,
  "firstName": "DAWEN",
  "firstNameCN": "大文",
  "surname": "CHEN",
  "surnameCN": "陈",
  "address": "上海市黄浦区南京东路333号202室",
  "method": "UNIONPAY",
  "destination": {
    "method": "ALIPAY",
    "destination": {
      "firstName": "DAWEN",
      "surname": "CHEN",
      "alipayId": "13112345678",
      "relationship": "Parents",
      "address": "Najlepsi pogled sa 118 sprata na Shenzhe"
    }
  },
  "amount": 123,
  "currency": "<string>",
  "source": {
    "firstName": "<string>",
    "surname": "<string>",
    "nationality": "Hong Kong",
    "address": "<string>",
    "idType": "national-id",
    "idNumber": "<string>",
    "dateOfBirth": "1999-09-09",
    "mobileNumber": "+85212345678"
  }
}
'
{
  "valid": true,
  "message": "<string>"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
accountNumber
string
required

UnionPay account​ number (mainland china resident account holders only)

Pattern: ^\d{16,19}$
Example:

6225888888888888

​
firstName
string
required

Account holder's first name

Example:

"DAWEN"

​
firstNameCN
string
required

Account holder first name in Chinese

Pattern: ^[\u4e00-\u9fa5]+$
Example:

"大文"

​
surname
string
required

Account holder surname

Example:

"CHEN"

​
surnameCN
string
required

The receiver's surname in Chinese

Example:

"陈"

​
address
string
required

The account's address. Can be in Chinese or English. Must be longer than 20 characters and contain at least one space and one number. Chinese characters will be automatically converted to pinyin.

Example:

"上海市黄浦区南京东路333号202室"

​
method
enum<string>
required
Available options:
UNIONPAY,
ALIPAY,
BANK_TRANSFER
​
destination
Alipay Account · object
required

Payout destination

Example:
{
  "method": "ALIPAY",
  "destination": {
    "firstName": "DAWEN",
    "surname": "CHEN",
    "alipayId": "13112345678",
    "relationship": "Parents",
    "address": "Najlepsi pogled sa 118 sprata na Shenzhe"
  }
}
​
amount
number

Destination amount of payout

​
currency
string

Destination currency of payout

​
source
object

Optional source information for the payout sender

Response

Payout Parameters Validated

​
valid
boolean

Whether the payout destination is valid

​
message
string

Message describing the validation result