Payouts to China

Payout parameters

When performing payouts to a bank card, you generally need to specify the following:

• card number
• payout recipient details
• payout sender details
• payout details: amount and currency

How to perform a payout to a bank card

Name	Mandatory	Type	Description
payment_method/payout_details	+	object	Payout details
type	+	string	value: card
card	+	object	Bank card payment details
type	+	string	Value: bank_card
bank_card	- (mandatory for payouts to unencrypted bank cards)	object	Unencrypted card details
number	- (mandatory for payouts to unencrypted bank cards)	string	Unencrypted bank card number
type	+	string	Value: encrypted_card
encrypted_card	- (mandatory for payouts to bank cards with tokenized details)	object	Encrypted card details
number_hash	- (mandatory for payouts to bank cards with tokenized details)	string	Card number hash
participant_details	+	object	Information on the payout participants
recipient	+	object	Recipient details
address_line	- (mandatory for payouts in USD)	string	Recipient's street address. Limited to 256 characters. Important: the city and country must be specified in the following fields. Do not duplicate them here
city	+	string	Recipient's city
postal_code	+	string	Recipient's postal code
state	+	string	Recipient's country state
bank_name	+	string	Recipient's bank name, as stated in the Supported banks list
swift_bic_code	- (mandatory for payouts in USD)	string	Recipient's bank’s SWIFT or BIC code
currency	+	string	Recipient's currency in ISO 4217 format. The value is CNY. Case insensitive
country_iso3	+	string	Recipient's bank country code
full_name	+	string	Recipient's full name. Can be combined from first_name and last_name in certain cases
first_name	- (mandatory for payouts in USD)	string	Recipient's first name
last_name	- (mandatory for payouts in USD)	string	Recipient's last name
email	+	string	Recipient's email
msisdn	+	string	Recipient's mobile wallet address
identity_document	+	object	Recipient's identity document
id_type	- (mandatory for payouts in CNY)	string	Recipient's identity document type. The value is NATIONAL_ID
id_number	- (mandatory for payouts in CNY)	string	Recipient's identity document number. Limited to 18 digits
id_expiration_date	+	string	Recipient's identity document expiration date
description	+	string	Purpose of remittance for the payout. This description should match the classification given in How to specify a purpose of remittance
sender	+	object	Sender details
full_name	+	string	Sender's full name in case of individual
company_name	+	string	Sender's company name in case of business
registration_number	+	string	Sender's company registration number
date_of_incorporation	+	string	Sender's company date of incorporation
country_iso3	+	string	Sender's country code (ISO-3166-1 alpha-3)
address_line	+	string	Sender's address
city	+	string	Sender's city
state	+	string	Sender's state
amount_details	+	object	Payout amount details
amount	+	int	Payout amount in decimal format. The value must be greater than zero. To send 100 USD, specify 10000
currency	+	string	ISO 4217 currency code. Case insensitive

Example

curl -X POST \
  https://demo.smart-glocal.com/api/v1/session/start/payout \
  -H 'Content-Type: application/json' \
  -H 'X-PARTNER-PROJECT: your_project_name' \
  -H 'X-PARTNER-SIGN: signature' \
  -d'{
    "session_id": "ps_1053680",
    "payment_method": {
      "type": "card",
      "card": {
        "type": "bank_card",
        "bank_card": {
          "number": "4242424242424242"
        }
      }
    },
    "participant_details": {
      "recipient": {
        "address_line": "Green street",
        "city": "Washington",
        "postal_code": "129164",
        "state": "Washington",
        "bank_name": "Bank name",
        "swift_bic_code": "AXISINBB250",
        "currency": "USD",
        "country_iso3": "USA",
        "first_name": "John",
        "last_name": "Johnson",
        "email": "test@gmail.com",
        "msisdn": "33712345678",
        "identity_document": {
          "id_type": "NATIONAL_ID",
          "id_number": "123456789",
          "id_expiration_date": "2030-01-01"
        },
        "description": "purpose of remittance"
      },
      "sender": {
        "company_name": "Company name",
        "registration_number": "1234567890",
        "date_of_incorporation": "2020-11-11",
        "country_iso3": "USA",
        "address_line": "Wall street",
        "city": "New York",
        "state": "New York"
      }
    },
    "amount_details": {
      "amount": 1000,
      "currency": "usd"
    }
  }'

Bank account

Payout parameters

Name	Mandatory	Type	Description
payment_method/payout_details	+	object	Payout data
type	+	string	Value: bank_account
bank_account	+	object	Bank account
system_type	+	string	Value: global
global	+	object	Bank account details
description	+	string	Purpose of remittance for the payout. This description should match the classification given in How to specify the remittance purpose
bank_account_number	+	string	Bank account number for the payout
participant_details	+	object	Information on the payout participants
recipient	+	object	Recipient details
full_name	+	string	Recipient's full name
address_line	- (mandatory for payouts in USD)	string	Recipient's street address. Limited to 256 characters
city	+	string	Recipient's city
postal_code	+	string	Recipient's postal code
state	+	string	Recipient's state
bank_name	+	string	Bank name
swift_bic_code	+	string	Recipient's bank’s SWIFT or BIC code
currency	+	string	Recipient's currency in ISO 4217 format. Case insensitive
country_iso3	+	string	Recipient's country code (ISO-3166-1 alpha-3)
first_name	+	string	Recipient's first name. Important: if the name is passed incorrectly, the recipient bank may not accept the payout.
last_name	+	string	Recipient's last name. Important: if the name is passed incorrectly, the recipient bank may not accept the payout.
email	+	string	Recipient's email
msisdn	+	string	Recipient's mobile wallet address
identity_document	+	object	Recipient's identity document
id_type	- (mandatory for payouts in CNY)	string	Recipient's ID type. Value: ID_NUMBER
id_number	- (mandatory for payouts in CNY)	string	Recipient's identity document number. Limited to 18 digits
id_expiration_date	+	string	Recipient's identity document expiration date
sender	+	object	Sender details
full_name	+	string	Sender’s full name (for individuals)
company_name	+	string	Sender company name. Limited to 100 characters, cannot contain digits only
registration_number	+	string	Sender company registration number
date_of_incorporation	- (mandatory for payouts in CNY)	string	Sender company date of incorporation.
country_iso3	+	string	Sender’s country code (ISO-3166-1 alpha-3)
address_line	+	string	Sender's address
city	+	string	Sender's city
code	+	string	Sender’s identification code
state	+	string	Sender's state
code	+	string	Sender’s identification code
amount_details	+	object	Payout amount details
amount	+	int	Payout amount in decimal format. The value must be greater than zero. To send 100 USD, write 10000
currency	+	string	ISO 4217 currency code. Case insensitive

Example

curl -X POST \
  https://demo.smart-glocal.com/api/v1/session/start/payout \
  -H 'Content-Type: application/json' \
  -H 'X-PARTNER-PROJECT: your_project_name' \
  -H 'X-PARTNER-SIGN: signature' \
  -d'{
    "session_id": "ps_1053680",
    "payment_method": {
      "type": "bank_account",
      "bank_account": {
        "system_type": "global",
        "global": {
          "bank_account_number": "NUMBER_VALUE",
          "description": "purpose of remittance"
        }
      }
    },
    "participant_details": {
      "recipient": {
        "address_line": "Green street",
        "city": "Shanghai",
        "postal_code": "129164",
        "state": "Shanghai",
        "bank_name": "Bank name",
        "swift_bic_code": "AXISINBB250",
        "currency": "CNY",
        "country_iso3": "CHN",
        "first_name": "John",
        "last_name": "Johnson",
        "email": "test@ya.cn",
        "msisdn": "33712345678",
        "identity_document": {
          "id_type": "NATIONAL_ID",
          "id_number": "123456789",
          "id_expiration_date": "2030-01-01"
        }
      },
      "sender": {
        "company_name": "Company name",
        "registration_number": "1234567890",
        "date_of_incorporation": "2020-11-11",
        "country_iso3": "USA",
        "address_line": "Wall street",
        "city": "New York",
        "code": "placeholder",
        "state": "New York"
      }
    },
    "amount_details": {
      "amount": 1000,
      "currency": "usd"
    }
  }'