Deactivate a beneficiary

curl --request DELETE \
  --url https://api.paystack.com/v1/beneficiaries/{beneficiaryId} \
  --header 'Authorization: Bearer <token>'

{
  "status": true,
  "message": "Beneficiary has been successfully deactivated",
  "code": "ok",
  "data": {
    "id": "ben_01KPBAP7WTDKQKW5B3R31VPNX4",
    "success": true
  },
  "meta": {
    "request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
    "timestamp": "2026-05-14T15:43:55.732Z",
    "version": "1"
  }
}

Beneficiaries

Deactivate a beneficiary

Deactivates a beneficiary by changing its status to archived. The beneficiary record is preserved — list and get continue to return it.

The path id is the GlobalStack external identifier (ben_…).

Response

{
  "status": true,
  "message": "Beneficiary has been successfully deactivated",
  "code": "ok",
  "data": {
    "id": "ben_01KPBAP7WTDKQKW5B3R31VPNX4",
    "success": true
  },
  "meta": { "request_id": "req_…", "timestamp": "…", "version": "1" }
}

Status preconditions

pending → archived.
active → archived.
archived → 409 invalid_status (not idempotent).

Errors

400 invalid_input — beneficiary_id does not start with ben_.
404 not_found — id does not exist or belongs to a different integration.
409 invalid_status — beneficiary is already archived.

Example

DELETE /v1/beneficiaries/ben_01KPBAP7WTDKQKW5B3R31VPNX4

DELETE

beneficiaries

{beneficiaryId}

Deactivate a beneficiary

curl --request DELETE \
  --url https://api.paystack.com/v1/beneficiaries/{beneficiaryId} \
  --header 'Authorization: Bearer <token>'

{
  "status": true,
  "message": "Beneficiary has been successfully deactivated",
  "code": "ok",
  "data": {
    "id": "ben_01KPBAP7WTDKQKW5B3R31VPNX4",
    "success": true
  },
  "meta": {
    "request_id": "req_01HXYZ4K5ABCDEFGHJKLMNPQRS",
    "timestamp": "2026-05-14T15:43:55.732Z",
    "version": "1"
  }
}

Authorizations

Authorization

string

header

required

API key issued during merchant onboarding.

Path Parameters

beneficiaryId

string

required

Pattern: [^\/#\?]+?

Response

Beneficiary has been successfully deactivated

status

enum<boolean>

required

Available options:

true

Example:

true

message

string

required

Human-readable summary

Example:

"Beneficiary has been successfully deactivated"

code

enum<string>

required

Available options:

ok

Example:

"ok"

data

object

required

Show child attributes