Deactive

Developing

DELETE

/api/v1/partner/payouts/remittances/recipients/businesses/{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/businesses/' \
--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-19T03:51:34.374+00:00",
    "data": {
        "id": "6a653804-dee0-4f8f-8a07-b92bd852cf50",
        "recipientCountryCode": "USA",
        "recipientCountry": "United States",
        "recipientCurrencyCode": "USD",
        "recipientType": "BUSINESS",
        "status": "INACTIVE",
        "isActive": false,
        "isNeedUpdate": false,
        "ownershipStatus": "ROOT",
        "ownershipId": "93cffe3b-effc-494a-a1f7-3ed04c7f75ce",
        "lastActiveAt": "2025-09-19T03:44:21Z",
        "lastInactiveAt": "2025-09-19T03:51:34Z",
        "inactiveReason": "External Status: PENDING",
        "createdAt": "2025-09-12T02:20:30Z",
        "createdBy": "(API_PARTNER) Lingkar Sembilan Titian Media",
        "updatedAt": "2025-09-19T03:51:34Z",
        "updatedBy": "(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 03:57:43

Update

Reactive