Recipient Form

Developing

GET

/api/v1/partner/payouts/remittances/recipients/personals/forms/{recipient_country_code}

Recipient form is used when creating a new recipient. This form/payload structure is determined based on the selected recipient country, and each country has a different payload format according to its regulations and data requirements.

You must provide recipient data according to the fields/parameters defined in the recipient form for that country. If any required fields are missing or the data format is invalid, the system will reject the request and return an error response.

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

No	Recipient Country	Recipient Country Code
1	United States of America	USA
2	Hongkong	HKG
3	Japan	JPN
4	United Kingdom	GBR

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. Please use country codes in the ISO 3166-1 alpha-3 (3-letter) format in the country field.

Request

Path Params

Header Params

Responses

🟢200Success

application/json

Body

🟠400Invalid Data

🟠401Unauthorized

🟠404Resource not found

🟠404Data Not Found

🟠401Token Expired

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/v1/partner/payouts/remittances/recipients/personals/forms/' \
--header 'Authorization: {{token}}' \
--header 'ClientSecret: {{ClientSecret}}' \
--header 'Signature: {{signature}}' \
--header 'Date: {{dateRequest}}' \
--header '{{userKey}}: {{userKey}}'

Response Example

200 - Success

{
    "status": 200,
    "serviceStatus": "2001401",
    "titleCode": "success",
    "title": "Success",
    "detail": "Processed successfully",
    "responseTime": "2025-09-08T04:40:43.758+00:00",
    "data": {
        "version": "1",
        "latestUpdated": "2025-08-25T15:19:02Z",
        "recipientCountryCode": "HKG",
        "recipientCountry": "HONG KONG",
        "recipientType": "PERSONAL",
        "recipientForm": [
            {
                "fieldGroupKey": "bank_details",
                "fieldGroupLabel": "Bank Details",
                "fields": [
                    {
                        "fieldGroupKey": "bank_details",
                        "fieldKey": "account_number",
                        "fieldLabel": "Account Number",
                        "fieldType": "string",
                        "isMandatory": false,
                        "isEditable": false,
                        "validation": {
                            "maxLength": "100",
                            "minLength": "1",
                            "regex": "^[#.0-9a-zA-Z\\s,/\\_:+?')(@#!&-]+$"
                        }
                    },
                    {
                        "fieldGroupKey": "bank_details",
                        "fieldKey": "account_code",
                        "fieldLabel": "Account Code",
                        "fieldType": "string",
                        "isMandatory": false,
                        "isEditable": false,
                        "validation": {
                            "maxLength": "100",
                            "minLength": "1",
                            "regex": "^[#.0-9a-zA-Z\\s,/\\_:+?')(@#!&-]+$"
                        }
                    },
                    {
                        "fieldGroupKey": "bank_details",
                        "fieldKey": "account_iban",
                        "fieldLabel": "Account Iban",
                        "fieldType": "string",
                        "isMandatory": false,
                        "isEditable": false,
                        "validation": {
                            "maxLength": "100",
                            "minLength": "1",
                            "regex": "^[#.0-9a-zA-Z\\s,/\\_:+?')(@#!&-]+$"
                        }
                    },
                    {
                        "fieldGroupKey": "bank_details",
                        "fieldKey": "account_name",
                        "fieldLabel": "Account Name",
                        "fieldType": "string",
                        "isMandatory": true,
                        "isEditable": true,
                        "validation": {
                            "maxLength": "100",
                            "minLength": "1",
                            "regex": "^[#.0-9a-zA-Z\\s,/\\_:+?')(@#!&-]+$"
                        }
                    },
                    {
                        "fieldGroupKey": "bank_details",
                        "fieldKey": "account_type_id",
                        "fieldLabel": "Account Type Id",
                        "fieldType": "string",
                        "isMandatory": true,
                        "isEditable": true,
                        "validation": {
                            "maxLength": "100",
                            "minLength": "1",
                            "regex": "^[#.0-9a-zA-Z\\s,/\\_:+?')(@#!&-]+$"
                        }
                    },
                    {
                        "fieldGroupKey": "bank_details",
                        "fieldKey": "bank_id",
                        "fieldLabel": "Bank Id",
                        "fieldType": "string",
                        "isMandatory": true,
                        "isEditable": true,
                        "validation": {
                            "maxLength": "100",
                            "minLength": "1",
                            "regex": "^[#.0-9a-zA-Z\\s,/\\_:+?')(@#!&-]+$"
                        }
                    },
                    {
                        "fieldGroupKey": "bank_details",
                        "fieldKey": "bank_name",
                        "fieldLabel": "Bank Name",
                        "fieldType": "string",
                        "isMandatory": true,
                        "isEditable": true,
                        "validation": {
                            "maxLength": "100",
                            "minLength": "1",
                            "regex": "^[#.0-9a-zA-Z\\s,/\\_:+?')(@#!&-]+$"
                        }
                    },
                    {
                        "fieldGroupKey": "bank_details",
                        "fieldKey": "bank_branch_id",
                        "fieldLabel": "Bank Branch Id",
                        "fieldType": "string",
                        "i

Modified at 2025-09-19 04:41:59

History List

Create