Skip to Content
Apex Settlement
End customers

Suspend an End Customer

Required permissioncustomer:end_customers:manage
POST
/v1/end-customers/{id}/suspend

Suspends an active End Customer of the Platform: it can still read, but changes nothing and sends no new Payouts until reactivated; Payouts already handed to a Provider run their course. Allowed while the Platform itself is suspended.

Requires the customer:end_customers:manage permission.

Authorization

ApiKey
headerAuthorizationBearer <API key>

A Customer API key, created by a Customer admin in the Customer panel and shown once: Authorization: Bearer ak_live_… in production, ak_test_… elsewhere. A key holds a subset of its creator's permissions and may be limited to named IP addresses and an expiry date. Keys never manage people, other keys or approval rules, and never approve a Payout.

Path Parameters

id*string

The End Customer's id.

Formatuuid

Request Body

Why.

application/json
  1. body
reason*string
Lengthlength <= 2000

Response Body

OK

application/json
  1. response
country*string
created_at*string
Formatdate-time
email*string
has_people?boolean

has_people is answered on one End Customer, not on a list row.

id*string
legal_name*string
providers*array<>
standing*string
Value in"onboarding""active""suspended""closed"
state*string
Value in"profile_pending""profile_review""provider_onboarding""active""suspended""rejected"
suspended_by?string

suspended_by is who suspended it: platform (the Platform may reactivate it) or operator (only the operations team can).

Value in"operator""platform"
suspended_reason?string

suspended_reason is the Platform's own reason, shown when the Platform suspended it.

type*string
Value in"individual""business"
updated_at*string
Formatdate-time
Example Request
curl -X POST 'http://localhost:3480/v1/end-customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/suspend' \  -H 'Content-Type: application/json' \  -d '{  "reason": "Documents under review by our compliance team."}'
Example Response
{  "country": "PK",  "created_at": "2026-11-10T14:05:00Z",  "email": "lina@example.com",  "has_people": false,  "id": "3f6c2a9e-8b1d-4c7a-9e2f-5a6b7c8d9e0f",  "legal_name": "Lina Qureshi",  "providers": [    {      "provider": "bvnk",      "state": "approved"    }  ],  "standing": "active",  "state": "active",  "suspended_by": "operator",  "suspended_reason": "string",  "type": "individual",  "updated_at": "2026-11-11T10:20:00Z"}