JUjustifi
Payees

Archive a Payee

Archive a payee. Archiving is a soft delete: the payee's record and payment history are retained, but the payee can no longer be paid. Returns the archived payee.

Archiving reaches the payments already in flight, up to a point. A credit already submitted to the network completes — nothing recalls an ACH entry. A payment still holding the payer's funds is not paid out: it stays held rather than failing, and would resume only if the payee were active again, which archiving rules out. Archiving is also always allowed, whatever the payer account's status.

Archiving is one-way — there is no unarchive operation, and status is not writable through UpdatePayee. To pay a party again after archiving it, create a new payee.

delete/payables/payer_accounts/{payer_id}/payees/{id}

Request

Path parameters

payer_idstring required

the payer account this request is scoped to. Every payee, bank account, and payment lives under one payer account, so it is part of the path on all operate (Tier 1) routes.

idstring required

the id of the resource

Headers

Authorizationstring required

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Response

Payee was archived successfully

idstring required

the object id, also found in the data object

typestring required

the object type

page_infounknown required

Example response

{
  "id": "prefix_xyz (same as id of data object)",
  "type": "payee",
  "data": {
    "id": "pe_abc123",
    "type": "payee",
    "payer_account_id": "payer_123xyz",
    "name": "Acme Plumbing LLC",
    "entity_type": "limited_liability_company",
    "email": "billing@acmeplumbing.com",
    "tax_id_last4": "4021",
    "address": {
      "line1": "123 Example St",
      "line2": "Suite 101",
      "city": "Minneapolis",
      "state": "MN",
      "postal_code": "55555",
      "country": "USA"
    },
    "receiving_bank_account_id": "ba_recv123",
    "status": "active",
    "metadata": {
      "erp_payee_id": "V-4021"
    },
    "created_at": "2026-01-01T12:00:00Z",
    "updated_at": "2026-01-01T12:00:00Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.