Add Payee

POST

/api/v1/ex/fundout/payee

Supports adding both individual and enterprise payees. If additional payee documents are required, such as a cooperation agreement between the merchant and supplier, the Payee Review Result Notification API identifies the required documents. Upload them through the Supplement Business Documents API.

Request

Header Params

Body Params application/json

Example

{
    "bizOrderNo":"2026010401113",
    "merchantNo": "25052514323069",
    "remarkName": "HK USDIndividual",
    "type": "personal",
    "person": {
        "firstName": "HUAHUA",
        "lastName": "TIAN"
    },
    "enterprise": {
        "name": "",
        "legalName": "",
        "legalCertType": "",
        "legalCertNo": ""
    },
    "countryCode": "HK",
    "classification": "GODS",
    "provinceName": "",
    "cityName": "",
    "address": "24 KING WILLIAM STREET FLOOR 9",
    "postcode": "EC4R 9AJ",
    "email": "wang@ipaylinks.com",
    "bankAccountName": "HK USD",
    "bankAccount": "zaYq82zYKEoK0T9ZKLJqrdIR6b1+HUIXVoywZPUBTLfolXCtrCe8j2cw40Qt",
    "bankName": "BANKING CIRCLE S.A.",
    "bankBranchName": "BANKING CIRCLE S.A.",
    "bankCountryCode": "HK",
    "currency": "USD",
    "paymentMethod": "SWIFT",
    "bankPhoneNumber": "18621758498",
    "occupation": "10600",
    "certType": "EEP",
    "certNumber": "N/2dKkRzAl6Qon9MBl1+wtla3hjHidCvu6kzp45BVuRVliptqpUdz+BZVP/+bA==",
    "issuingAuthority": "Shanghai CityPutuo Branch of the Public Security Bureau",
    "certExpirationBegin": "20210719",
    "certExpirationEnd": "20290719",
    "accountRoutingValue1": "ABFLHKHH",
    "accountRoutingValue2": "",
    "urls": [
        {
            "url": ""
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/api/v1/ex/fundout/payee' \
--header 'x-app-id;' \
--header 'x-request-id;' \
--header 'x-signature;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "bizOrderNo":"2026010401113",
    "merchantNo": "25052514323069",
    "remarkName": "HK USDIndividual",
    "type": "personal",
    "person": {
        "firstName": "HUAHUA",
        "lastName": "TIAN"
    },
    "enterprise": {
        "name": "",
        "legalName": "",
        "legalCertType": "",
        "legalCertNo": ""
    },
    "countryCode": "HK",
    "classification": "GODS",
    "provinceName": "",
    "cityName": "",
    "address": "24 KING WILLIAM STREET FLOOR 9",
    "postcode": "EC4R 9AJ",
    "email": "wang@ipaylinks.com",
    "bankAccountName": "HK USD",
    "bankAccount": "zaYq82zYKEoK0T9ZKLJqrdIR6b1+HUIXVoywZPUBTLfolXCtrCe8j2cw40Qt",
    "bankName": "BANKING CIRCLE S.A.",
    "bankBranchName": "BANKING CIRCLE S.A.",
    "bankCountryCode": "HK",
    "currency": "USD",
    "paymentMethod": "SWIFT",
    "bankPhoneNumber": "18621758498",
    "occupation": "10600",
    "certType": "EEP",
    "certNumber": "N/2dKkRzAl6Qon9MBl1+wtla3hjHidCvu6kzp45BVuRVliptqpUdz+BZVP/+bA==",
    "issuingAuthority": "Shanghai CityPutuo Branch of the Public Security Bureau",
    "certExpirationBegin": "20210719",
    "certExpirationEnd": "20290719",
    "accountRoutingValue1": "ABFLHKHH",
    "accountRoutingValue2": "",
    "urls": [
        {
            "url": ""
        }
    ]
}'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "code": "string",
    "message": "string",
    "data": {
        "payeeAccountId": "string",
        "status": "string"
    }
}

Modified at 2026-08-08 08:08:06

Collection Crediting Notification

Delete Payee