Recipient List

Developing

GET

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

This endpoint is used to retrieve a collection of all registered recipients in the system. The response includes key information such as recipientDetails, and status (active or inactive). If no recipient data is available, the system will return a Data Not Found error response.

Request

Query Params

Header Params

Responses

🟢200Success

application/json

Body

🟠400Invalid Data

🟠401Unauthorized

🟠401Token Expired

🟠404Data Not Found

🟠401Invalid Account

🟠400Validation Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/v1/partner/payouts/remittances/recipients/personals?page=1&limit=10' \
--header 'Authorization: {{token}}' \
--header 'ClientSecret: {{ClientSecret}}' \
--header 'Signature: {{signature}}' \
--header 'Date: {{dateRequest}}' \
--header 'X-User-Key: {{userKey}}'

Response Example

200 - Success

{
    "status": 200,
    "serviceStatus": "2001701",
    "titleCode": "success",
    "title": "Success",
    "detail": "Processed successfully",
    "responseTime": "2025-09-19T10:00:50.401+00:00",
    "data": [
        {
            "id": "64107dbd-305e-45e7-adc1-ed7674c94927",
            "recipientCountryCode": "HKG",
            "recipientCountry": "HONG KONG",
            "recipientCurrencyCode": "HKD",
            "recipientType": "PERSONAL",
            "status": "ACTIVE",
            "isActive": true,
            "isNeedUpdate": false,
            "ownershipStatus": "ROOT",
            "ownershipId": "93cffe3b-effc-494a-a1f7-3ed04c7f75ce",
            "lastActiveAt": "2025-09-19T09:57:56Z",
            "lastInactiveAt": "2025-09-19T09:57:08Z",
            "inactiveReason": "External Status: PENDING",
            "createdAt": "2025-09-19T09:46:22Z",
            "createdBy": "(API_PARTNER) Lingkar Sembilan Titian Media",
            "updatedAt": "2025-09-19T09:57:56Z",
            "updatedBy": "(API_PARTNER) Lingkar Sembilan Titian Media",
            "recipientDetails": {
                "bankDetails": {
                    "accountNumber": "12345678902",
                    "accountCode": "122",
                    "accountName": "Alex Chun Wong",
                    "accountTypeId": "5d7e4f2f-c8ea-4a2f-b83d-cb1d162a4db0",
                    "accountTypeName": "Savings Account",
                    "bankId": "RMT1-473d0d0d633a47458204b1e10e114f67",
                    "bankName": "AAREAL BANK AG, WIESBADEN, GERMANY"
                },
                "identificationDetails": {
                    "typeId": "93a603a6-6446-44f1-8971-6c7316aadf0f",
                    "typeName": "Voter's photo ID card",
                    "idNumber": "R1234567",
                    "issueCountryCode": "HKG",
                    "issueCountry": "Hong Kong",
                    "issueDate": "2020-12-19",
                    "expiredDate": "2028-01-12",
                    "issueState": "Hong Kong",
                    "issueCity": "Hong Kong",
                    "issuePlace": "Immigration Tower, Wan Chai",
                    "issueAuthority": "Hong Kong Immigration Department"
                },
                "userInformation": {
                    "firstName": "Alex",
                    "middleName": "Chun",
                    "lastName": "Wong",
                    "fullName": "Alex Chun Wong",
                    "preferredName": "Alex Wong",
                    "emailAddress": "alex.wong@example.com",
                    "phonePrefix": "852",
                    "phoneNumber": "91234567",
                    "genderId": "8fd45597-7917-49a8-8883-de973749781e",
                    "genderName": "Male",
                    "pobCountryCode": "HKG",
                    "pobCountry": "Hong Kong",
                    "pob": "Hong Kong",
                    "dob": "1998-01-13",
                    "nationalityId": "49df8137-fc95-40e1-8dce-182266ca977f",
                    "nationalityName": "Belgian",
                    "occupationId": "7035288a-2447-479f-a61b-388d366f28ec",
                    "occupationName": "Professional",
                    "sourceOfIncomeId": "13924444-2214-4670-b75d-d633cc1023d6",
                    "sourceOfIncomeName": "Salary"
                },
                "businessInformation": {},
                "addressDetails": {
                    "countryCode": "HKG",
                    "state": "Hong Kong Island",
                    "city": "Hong Kong",
                    "district": "Central and Western",
                    "subdistrict": "Central",
                    "zipcode": "00000",
                    "address": "88 Connaught Road Central"
                },
                "additionalData": {
                    "purposeOfPaymentId": "60ec494f-2ab8-4095-a341-b8fe5141d5b5",
                    "purposeOfPaymentName": "Family Maintenance",
                    "recipientRelationshipId": "ba3795bd-27c4-406c-9445-9f8bd6c51f88",
                    "recipientRelationshipName": "Daughter"
                }
            }
        },
        {
            "id": "aca748dc-b9e8-45e2-9737-678dc7894ce9",
            "recipientCountryCode": "HKG",
            "recipientCountry": "HONG KONG",
            "recipientCurrencyCode": "HKD",
            "recipientType": "PERSONAL",
            "status": "ACTIVE",
            "isActive": true,
            "isNeedUpdate": false,
            "ownershipStatus": "ROOT",
            "ownershipId": "93cffe3b-effc-494a-a1f7-3ed04c7f75ce",
            "lastActiveAt": "2025-09-19T10:00:03Z",
            "lastInactiveAt": "2025-09-19T09:12:14Z",
            "inactiveReason": "External Status: PENDING",
            "createdAt": "2025-09-19T09:12:14Z",
            "createdBy": "(API_PARTNER) Lingkar Sembilan Titian Media",
            "recipientDetails": {
                "bankDetails": {
                    "accountNumber": "12345678901",
                    "accountCode": "123",
                    "accountName": "Eni",
                    "accountTypeId": "5d7e4f2f-c8ea-4a2f-b83d-cb1d162a4db0",
                    "accountTypeName": "Savings Account",
                    "bankId": "RMT1-473d0d0d633a47458204b1e10e114f67",
                    "bankName": "AAREAL BANK AG, WIESBADEN, GERMANY"
                },
                "identificationDetails": {
                    "typeId": "93a603a6-6446-44f1-8971-6c7316aadf0f",
                    "typeName": "Voter's photo ID card",
                    "idNumber": "R1234567",
                    "issueCountryCode": "HKG",
                    "issueCountry": "Hong Kong",
                    "issueDate": "2020-12-19",
                    "expiredDate": "2028-01-12",
                    "issueState": "Hong Kong",
                    "issueCity": "Hong Kong",
                    "issuePlace": "Immigration Tower, Wan Chai",
                    "issueAuthority": "Hong Kong Immigration Department"
                },
                "userInformation": {
                    "firstName": "Alex",
                    "middleName": "Chun",
                    "lastName": "Wong",
                    "fullName": "Alex Chun Wong",
                    "preferredName": "Alex Wong",
                    "emailAddress": "alex.wong@example.com",
                    "phonePrefix": "852",
                    "phoneNumber": "91234567",
                    "genderId": "8fd45597-7917-49a8-8883-de973749781e",
                    "genderName": "Male",
                    "pobCountryCode": "HKG",
                    "pobCountry": "Hong Kong",
                    "pob": "Hong Kong",
                    "dob": "1998-01-13",
                    "nationalityId": "49df8137-fc95-40e1-8dce-182266ca977f",
                    "nationalityName": "Belgian",
                    "occupationId": "7035288a-2447-479f-a61b-388d366f28ec",
                    "occupationName": "Professional",
                    "sourceOfIncomeId": "13924444-2214-4670-b75d-d633cc1023d6",
                    "sourceOfIncomeName": "Salary"
                },
                "businessInformation": {},
                "addressDetails": {
                    "countryCode": "HKG",
                    "state": "Hong Kong Island",
                    "city": "Hong Kong",
                    "district": "Central and Western",
                    "subdistrict": "Central",
                    "zipcode": "00000",
                    "address": "88 Connaught Road Central"
                },
                "additionalData": {
                    "purposeOfPaymentId": "60ec494f-2ab8-4095-a341-b8fe5141d5b5",
                    "purposeOfPaymentName": "Family Maintenance",
                    "recipientRelationshipId": "ba3795bd-27c4-406c-9445-9f8bd6c51f88",
                    "recipientRelationshipName": "Daughter"
                }
            }
        },
        {
            "id": "c757475b-22f6-47a2-8a4a-108cbec32017",
            "recipientCountryCode": "USA",
            "recipientCountry": "United States",
            "recipientCurrencyCode": "USD",
            "recipientType": "PERSONAL",
            "status": "ACTIVE",
            "isActive": true,
            "isNeedUpdate": false,
            "ownershipStatus": "ROOT",
            "ownershipId": "93cffe3b-effc-494a-a1f7-3ed04c7f75ce",
            "lastActiveAt": "2025-09-19T07:06:28Z",
            "lastInactiveAt": "2025-09-16T08:19:49Z",
            "inactiveReason": "External Status: PENDING",
            "createdAt": "2025-09-16T08:19:49Z",
            "createdBy": "(API_PARTNER) Lingkar Sembilan Titian Media",
            "recipientDetails": {
                "bankDetails": {
                    "accountNumber": "09102124",
                    "accountCode": "091234562",
                    "accountName": "Emily Rose Johnson",
                    "accountTypeId": "5d7e4f2f-c8ea-4a2f-b83d-cb1d162a4db0",
                    "accountTypeName": "Savings Account",
                    "bankId": "RMT1-52ded49b9e704e579a49406acbc120bb",
                    "bankName": "1ST PMF BANCORP"
                },
                "identificationDetails": {
                    "typeId": "93a603a6-6446-44f1-8971-6c7316aadf0f",
                    "typeName": "Voter's photo ID card",
                    "idNumber": "R1234567",
                    "issueCountryCode": "USA",
                    "issueCountry": "United States",
                    "issueDate": "2020-12-19",
                    "expiredDate": "2028-01-12",
                    "issueState": "California",
                    "issueCity": "San Francisco",
                    "issuePlace": "San Francisco DMV",
                    "issueAuthority": "California Department of Motor Vehicles"
                },
                "userInformation": {
                    "firstName": "Emily",
                    "middleName": "Rose",
                    "lastName": "Johnson",
                    "fullName": "Emily Rose Johnson",
                    "preferredName": "Emily Johnson",
                    "emailAddress": "emily.johnson@example.com",
                    "phonePrefix": "1",
                    "phoneNumber": "4155551234",
                    "genderId": "8fd45597-7917-49a8-8883-de973749781e",
                    "genderName": "Male",
                    "pobCountryCode": "USA",
                    "pobCountry": "United States",
                    "pob": "San Francisco",
                    "dob": "1998-01-13",
                    "nationalityId": "49df8137-fc95-40e1-8dce-182266ca977f",
                    "nationalityName": "Belgian",
                    "occupationId": "7035288a-2447-479f-a61b-388d366f28ec",
                    "occupationName": "Professional",
                    "sourceOfIncomeId": "13924444-2214-4670-b75d-d633cc1023d6",
                    "sourceOfIncomeName": "Salary"
                },
                "businessInformation": {},
                "addressDetails": {
                    "countryCode": "USA",
                    "state": "California",
                    "city": "San Francisco",
                    "district": "Downtown",
                    "subdistrict": "Financial District",
                    "zipcode": "94105",
                    "address": "123 Market Street, Apt 45B"
                },
                "additionalData": {
                    "purposeOfPaymentId": "60ec494f-2ab8-4095-a341-b8fe5141d5b5",
                    "purposeOfPaymentName": "Family Maintenance",
                    "recipientRelationshipId": "ba3795bd-27c4-406c-9445-9f8bd6c51f88",
                    "recipientRelationshipName": "Daughter"
                }
            }
        }
    ],
    "pagination": {
        "limit": 10,
        "page": 1,
        "totalRecords": 3,
        "totalPages": 1,
        "links": {
            "self": "https://api-gateway-dev.remitpro.asia/api/v1/partner/payouts/remittances/recipients/personals?page=1&limit=10"
        }
    }
}

Modified at 2025-10-27 06:52:10

Recipient Detail

History List