Deactivate a wallet credential

curl --request DELETE \
  --url https://api.paystack.com/v1/wallets/{id}/credentials/{credentialId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'

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

Wallets

Deactivate a wallet credential

Deactivates a wallet credential by flipping its status to disabled. The credential record is preserved — list and get continue to return it.

The path ids are GlobalStack external identifiers: the wallet (wal_…) and the credential (wcr_…).

An optional JSON body { "reason": "…" } (max 255 chars) records why the credential was deactivated in disabled_reason.

Response

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

Status preconditions

pending → disabled.
active → disabled.
frozen → 409 invalid_status (a merchant cannot clear an internal/compliance freeze).
disabled → 409 invalid_status (not idempotent).

Errors

400 invalid_input — wal_… or wcr_… id is malformed.
401 authentication_failed — invalid or missing API key.
404 not_found — wallet or credential does not exist in this integration.
409 invalid_status — credential is already disabled or is frozen.

Example

DELETE /v1/wallets/wal_01HXYZABC1234567890ABCDEFG/credentials/wcr_01HXYZABC1234567890ABCDEFG

DELETE

wallets

{id}

credentials

{credentialId}

Deactivate a wallet credential

curl --request DELETE \
  --url https://api.paystack.com/v1/wallets/{id}/credentials/{credentialId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'

{
  "status": true,
  "message": "Wallet credential has been successfully deactivated",
  "code": "ok",
  "data": {
    "id": "wcr_01HXYZABC1234567890ABCDEFG",
    "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

string

required

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

credentialId

string

required

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

Body

application/json

DeactivateCredentialDto

reason

string

Maximum string length: 255

Response

Wallet credential has been successfully deactivated

status

enum<boolean>

required

Available options:

true

Example:

true

message

string

required

Human-readable summary

Example:

"Wallet credential has been successfully deactivated"

code

enum<string>

required

Available options:

ok

Example:

"ok"

data

object

required

Show child attributes