Deactive

Developing

DELETE

/api/v1/partner/payouts/remittances/recipients/personals/{recipient_id}

This endpoint is used to deactivate a recipient account in the system. Once a recipient is marked as deactivated:

Any transaction request that references this recipient ’s data will be automatically rejected by the system.

The system will return a specific error response indicating that the recipient is inactive and therefore cannot be used in any transaction process.

If you need to allow transactions again for the same recipient, you must explicitly reactivate the recipient . This can be done by calling the /reactive endpoint, which will restore the recipient’s status to active and re-enable the ability to perform transactions.

Request

Path Params

Header Params

Responses

🟢200Success

application/json

Body

🟠400Invalid Data

🟠401Unauthorized

🟠401Token Expired

🟠400Update Not Allowed

🟠404Data Not Found

🟠401Invalid Account

🟠400Validation Error

🟠400Update Not Allowed

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE '/api/v1/partner/payouts/remittances/recipients/personals/6a653804-dee0-4f8f-8a07-b92bd852cf50' \
--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-19T09:57:08.252+00:00",
    "data": {
        "id": "64107dbd-305e-45e7-adc1-ed7674c94927",
        "recipientCountryCode": "HKG",
        "recipientCountry": "HONG KONG",
        "recipientCurrencyCode": "HKD",
        "recipientType": "PERSONAL",
        "status": "INACTIVE",
        "isActive": false,
        "isNeedUpdate": false,
        "ownershipStatus": "ROOT",
        "ownershipId": "93cffe3b-effc-494a-a1f7-3ed04c7f75ce",
        "lastActiveAt": "2025-09-19T09:56:41Z",
        "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:08Z",
        "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"
            }
        }
    }
}

Modified at 2025-10-31 13:16:05

Update

Reactive