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

Get Started

  • Developer Overview
  • Branch Environments
  • API Versioning
  • Rate Limits
  • Manage Secret Keys
  • Application Security

Onboarding Workers

  • Employee Create
  • Wallet Create
    • Know Your Customer
    • Essential Account Wallet Creation
  • Wallet Closure
  • Embedded API
    • Add a Debit Card
    • Update a Debit Card
    • Display Last 4 Card PAN
    • Display Disbursement History
    • Display Payment Profile
    • Change Payment Profile
  • Worker and Employee Compatibility

Pay Workers

  • Create a Disbursement
    • Disbursement Invoices
    • Testing Disbursements to Branch Direct
  • Earned Wage Access
    • View Worker Advances
    • Deduct Worker Advances in Payroll Remittance

Webhooks

  • Webhook Implementation
  • Webhook Retries
  • 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

Reporting

  • Transaction Data Report Files

Invoice Transfer Initiated

Triggered when an invoice transfer is initiated

Event

INVOICE_TRANSFER_INITIATED

Data

invoice_id - Long
Unique ID for invoice

amount - Long
Amount of the invoice

description - String
Description of the invoice

Example

"data": {
  "invoice_id": 399742129664,
  "amount": 12456,
  "description": "Transferring invoice to XYZ"
}       

Updated about 2 months ago


  • Table of Contents
    • Event
    • Data
    • Example