Deactivate

Endpoint

PUT https://api.bindpay.xyz/v1/deactivate-subpayee

Headers

Header	Value	Description
Content-Type	application/json	The content type of the request body
x-api-key	Your API key	The subpayee creation API key of the parent business

Request body

Field	Type	Required	Description
subPayeeApiKey	String	Yes	The API key of the subpayee to be updated

Notes

Only the parent integrator can deactivate their subpayees
Must use the subpayee creation API key, not your primary API key
Deactivation is permanent and cannot be undone
Existing transactions will not be affected
New transactions using the deactivated subpayee's API key will be rejected

Example Request

curl -X PUT "https://api.bindpay.xyz/v1/deactivate-subpayee" \
     -H "Content-Type: application/json" \
     -H "x-api-key: your_subpayee_creation_api_key_here" \
     -d '{
       "subPayeeApiKey": "subpayee_api_key_to_deactivate"
     }'

Successful Response

{
  "message": "Subpayee deactivated successfully",
  "subPayeeName": "Example Subpayee",
  "deactivatedAt": "2024-03-19T12:34:56.789Z"
}

Notes:

Despite the settlement details changing, the subpayees API key will remain the same.
The response includes the previously stored settlement details for the sub-payee.
The updatedAt field in the previousDetails shows when the previous settlement details were set.

Response Codes

Status Code	Type	Description
200	Success	Subpayee successfully deactivated
400	Bad Request	Missing API key or already disabled.
404	Not Found	Parent business or subpayee not found
500	Internal Server Error	The server encountered an unexpected condition that prevented it from fulfilling the request.

Notes:

Responses use standard HTTP status codes for easy interpretation.

Still having issues? Reach out to us.