Create

Developing

POST

/api/v1/partner/payouts/remittances/recipients/personals

This endpoint only supports creating recipient personal for specific countries. Currently, the list of supported countries for business recipients is:

No	Recipient Country	Country Code	Currency Code
1	United States of America	USA	USD
2	Hongkong	HKG	HKD
3	Japan	JPN	JPY
4	United Kingdom	GBR	GBP

If you send a request with the country parameter outside of the list above, the system will reject the request and return an appropriate error status.

📌

Recipient data below represents a sample payload for the HKG. For payloads of other recipient countries, please refer to the this endpoint:/api/v1/partner/payouts/remittances/recipients/personals/forms/{recipient_country}, and ensure that you follow the validation rules provided there.

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠400Invalid Data

🟠401Unauthorized

🟠404Resource not found

🟠404Data Not Found

🟠401Token Expired

🟠400Validation Error

🟠409Duplicate Record

🔴500Internal Server Error

🟠400Invalid Data

🟠400Validation Error

🟠401Invalid Account

🟠400Invalid Data

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/partner/payouts/remittances/recipients/personals' \
--header 'Authorization: {{token}}' \
--header 'ClientSecret: {{ClientSecret}}' \
--header 'Signature: {{signature}}' \
--header 'Date: {{dateRequest}}' \
--header '{{userKey}}: {{userKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "recipientData": {
        "recipientCountryCode": "HKG",
        "recipientCurrencyCode": "HKD",
        "recipientDetails": {
            "userInformation": {
                "firstName": "Alex",
                "middleName": "Chun",
                "lastName": "Wong",
                "preferredName": "Alex Wong",
                "emailAddress": "alex.wong@example.com",
                "phonePrefix": "852",
                "phoneNumber": "91234567",
                "genderId": "8fd45597-7917-49a8-8883-de973749781e",
                "pobCountryCode": "HKG",
                "pob": "Hong Kong",
                "dob": "1998-01-13",
                "nationalityId": "49df8137-fc95-40e1-8dce-182266ca977f",
                "sourceOfIncomeId": "13924444-2214-4670-b75d-d633cc1023d6",
                "occupationId": "7035288a-2447-479f-a61b-388d366f28ec"
            },
            "bankDetails": {
                "accountNumber": "12345678901",
                "accountCode": "HSBC123456",
                "accountIban": "", // Optional
                "accountName": "Alex Chun Wong",
                "accountTypeId": "5d7e4f2f-c8ea-4a2f-b83d-cb1d162a4db0",
                "bankId": "RMT1-473d0d0d633a47458204b1e10e114f67",
                "bankName": "AAREAL BANK AG, WIESBADEN, GERMANY",
                "bankBranchId": "", // Optional 
                "bankBranchName": "" // Optional
            },
            "addressDetails": {
                "country_code": "HKG",
                "state": "Hong Kong Island",
                "city": "Hong Kong",
                "district": "Central and Western",
                "subdistrict": "Central",
                "zipcode": "00000",
                "address": "88 Connaught Road Central"
            },
            "identificationDetails": {
                "typeId": "93a603a6-6446-44f1-8971-6c7316aadf0f",
                "idNumber": "R1234567",
                "issueCountryCode": "HKG",
                "issueDate": "2020-12-19",
                "expiredDate": "2028-01-12",
                "issueState": "Hong Kong",
                "issueCity": "Hong Kong",
                "issuePlace": "Immigration Tower, Wan Chai",
                "issueAuthority": "Hong Kong Immigration Department"
            },
            "additionalData": {
                "purposeOfPaymentId": "60ec494f-2ab8-4095-a341-b8fe5141d5b5",
                "recipientRelationshipId": "ba3795bd-27c4-406c-9445-9f8bd6c51f88"
            }
        }
    }
}'

Response Example

200 - Success

{
    "status": 200,
    "serviceStatus": "2001701",
    "titleCode": "success",
    "title": "Success",
    "detail": "Processed successfully",
    "responseTime": "2025-09-12T02:20:31.974+00:00",
    "data": {
        "id": "6a653804-dee0-4f8f-8a07-b92bd852cf50",
        "recipientCountryCode": "USA",
        "recipientCountry": "United States",
        "recipientCurrencyCode": "USD",
        "recipientType": "BUSINESS",
        "status": "PENDING",
        "isActive": false,
        "isNeedUpdate": false,
        "ownershipStatus": "ROOT",
        "ownershipId": "93cffe3b-effc-494a-a1f7-3ed04c7f75ce",
        "lastInactiveAt": "2025-09-12T02:20:30Z",
        "inactiveReason": "External Status: PENDING",
        "createdAt": "2025-09-12T02:20:30Z",
        "createdBy": "(API_PARTNER) Lingkar Sembilan Titian Media",
        "recipientDetails": {
            "bankDetails": {
                "accountNumber": "09102123",
                "accountCode": "091234562",
                "accountName": "Pacific Horizon Solutions",
                "accountTypeId": "5d7e4f2f-c8ea-4a2f-b83d-cb1d162a4db0",
                "accountTypeName": "Savings Account",
                "bankId": "RMT1-8c0608f7ce7d4de99f6d9efe77841dea",
                "bankName": "ABANCA USA"
            },
            "identificationDetails": {
                "typeId": "93a603a6-6446-44f1-8971-6c7316aadf0f",
                "typeName": "Voter's photo ID card",
                "idNumber": "1234567890123456",
                "issueCountryCode": "USA",
                "issueCountry": "United States",
                "issueDate": "2020-12-19",
                "expiredDate": "2028-01-12",
                "issueState": "California",
                "issueCity": "San Francisco",
                "issuePlace": "450 Golden Gate Ave",
                "issueAuthority": "California Department of Motor Vehicles"
            },
            "userInformation": {
                "firstName": "Michael",
                "middleName": "Andrew",
                "lastName": "Johnson",
                "fullName": "Michael Andrew Johnson",
                "preferredName": "Mike",
                "emailAddress": "dummyuser+mikejohnson@gmail.com",
                "phonePrefix": "1",
                "phoneNumber": "2025550198",
                "genderName": "BYPASS",
                "pobCountryCode": "USA",
                "pobCountry": "United States",
                "pob": "New York",
                "dob": "1994-03-18",
                "nationalityName": "BYPASS",
                "occupationName": "BYPASS",
                "sourceOfIncomeName": "BYPASS"
            },
            "businessInformation": {
                "businessNumber": "BIZ-20250910",
                "businessName": "Pacific Horizon Solutions Inc.",
                "preferredName": "Pacific Horizon",
                "emailAddress": "contact+pacifichorizon@gmail.com",
                "phonePrefix": "1",
                "phoneNumber": "4155550134",
                "foundationDate": "2005-07-15",
                "foundationYear": "2005",
                "numberOfEmployee": "250",
                "nationalityName": "BYPASS"
            },
            "addressDetails": {
                "countryCode": "USA",
                "state": "California",
                "city": "Los Angeles",
                "district": "Downtown",
                "subdistrict": "Arts District",
                "zipcode": "90012",
                "address": "1234 Sunset Boulevard"
            },
            "additionalData": {
                "purposeOfPaymentId": "0a5ac571-f746-4afb-a528-9a3a5baffe64",
                "purposeOfPaymentName": "Household Maintenance",
                "recipientRelationshipId": "ba3795bd-27c4-406c-9445-9f8bd6c51f88",
                "recipientRelationshipName": "Daughter"
            }
        }
    }
}

Modified at 2025-09-19 07:04:13

Recipient Form

Update