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 '
{
  "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
​
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