Jump to Content
Branch Developer Docs
GuidesAPI ReferenceChangelog
Log InBranch Developer Docs
Guides
Log In
GuidesAPI ReferenceChangelog

Get Started

  • Get Started
  • Branch Environments
  • API Versioning
  • V2 API Migration guide
  • Rate Limits
  • Manage Secret Keys
  • About This Documentation

Onboard Workers

  • Onboarding Introduction
  • Worker and Employee Compatibility
  • Employee Create
  • Wallet Create
    • Essential Account Wallet Creation
  • Wallet Closure

Pay Workers

  • Disbursement Create
  • Testing Disbursements to Branch Direct

Earned Wage Access

  • View Employee Advances
  • EWA Remittance

Branch Direct Embedded

  • Onboarding New Workers
  • Application Security
  • Add a Debit Card
  • Update a Debit Card
  • Display Last 4 Card PAN
  • Display Payment Profile
  • Change Payment Profile
  • Display Disbursement History

Webhooks

  • Webhook Implementation
  • Webhook Reference
    • Account Verified as Worker
    • Account Review
    • Advance Adjustment
    • Advance Claimed
    • Card Activated
    • Card Deactivated
    • Invoice Created
    • Invoice Overdue
    • Invoice Transfer Initiated
    • KYC Fallback Failed
    • KYC Declined
    • Payment Profile Activated
    • Payment Profile Deactivated
    • Wallet Created
    • Wallet Claimed
    • Wallet Activated
    • Wallet Deactivated
    • Wallet Closed
  • Webhook Retries

Data Files

  • Transaction Data Report Files

Payment Profile Deactivated

This webhook is triggered when a payment method has been removed from a worker’s account, and the worker is no longer able to receive a disbursement.

Event

PAYMENT_PROFILE_DEACTIVATED

Data

employee_id - Int
Unique ID for the worker

time_emitted - datetime

Example

"data": {
  "employee_id": "123",
  "time_emitted": "2023-12-30T15:40:32-08:00"
}                

Updated 8 months ago


  • Table of Contents
    • Event
    • Data
    • Example