{
"info": {
"_postman_id": "37208943-18aa-45b1-b4f0-8c7d6ac3c07a",
"name": "WebhookEvents",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "37283496",
"_collection_link": "https://branchapp.postman.co/workspace/API-Documentation~afaf8240-7b44-4f60-9d05-855bd79c3b5e/collection/37283496-37208943-18aa-45b1-b4f0-8c7d6ac3c07a?action=share&source=collection_link&creator=37283496"
},
"item": [
{
"name": "Account Verified as Worker",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"employee_id\": \"123\",\n \"account_number\": \"1234567891234567\",\n \"routing_number\": \"084106768\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://sandbox.branchapp.com/v1/organizations/{{organizationID}}/webhooks/ACCOUNT_VERIFIED_AS_WORKER",
"protocol": "https",
"host": [
"sandbox",
"branchapp",
"com"
],
"path": [
"v1",
"organizations",
"{{organizationID}}",
"webhooks",
"ACCOUNT_VERIFIED_AS_WORKER"
]
},
"description": "This webhook is triggered when a worker is verified on an organization's roster. Routing and account number will return null if the worker's wallet has not yet been created."
},
"response": []
},
{
"name": "Account Review",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"employee_id\": \"123\",\n \"onboarding_link\": \"https://branchapp.com/ol1\"\n}\n\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://sandbox.branchapp.com/v1/organizations/{{organizationID}}/webhooks/ACCOUNT_REVIEW",
"protocol": "https",
"host": [
"sandbox",
"branchapp",
"com"
],
"path": [
"v1",
"organizations",
"{{organizationID}}",
"webhooks",
"ACCOUNT_REVIEW"
]
},
"description": "Triggered when a worker has been flagged for manual review"
},
"response": []
},
{
"name": "Advance Adjustment",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"adjustment_amount\": 641,\n \"advance_id\": \"18d99mn3bvf78094\",\n \"employee_id\": \"123\",\n \"original_outstanding_amount\": 99,\n \"outstanding_amount\": 444,\n \"timestamp\": \"2023-12-30T15:40:32-08:00\",\n \"type\": \"tp_pull\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://sandbox.branchapp.com/v1/organizations/{{organizationID}}/webhooks/ADVANCE_ADJUSTMENT",
"protocol": "https",
"host": [
"sandbox",
"branchapp",
"com"
],
"path": [
"v1",
"organizations",
"{{organizationID}}",
"webhooks",
"ADVANCE_ADJUSTMENT"
]
},
"description": "Triggered when an adjustment is made to an advance"
},
"response": []
},
{
"name": "Advance Claimed",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"advance_id\": \"18d99mn3bvf78094\",\n \"amount\":444,\n \"employee_id\": \"123\",\n \"timestamp\": \"2023-12-30T15:40:32-08:00\"\n}\n\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://sandbox.branchapp.com/v1/organizations/{{organizationID}}/webhooks/ADVANCE_CLAIMED",
"protocol": "https",
"host": [
"sandbox",
"branchapp",
"com"
],
"path": [
"v1",
"organizations",
"{{organizationID}}",
"webhooks",
"ADVANCE_CLAIMED"
]
},
"description": "Triggered when a worker claims an advance"
},
"response": []
},
{
"name": "Card Activated",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"employee_id\": \"123\",\n \"marqeta_card_token\": \"Acme_1099_Physical\",\n \"card_product\": \"Acme_1099\",\n \"card_type\": \"PHYSICAL\",\n \"time_emitted\": \"2023-12-30T15:40:32-08:00\"\n}\n\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://sandbox.branchapp.com/v1/organizations/{{organizationID}}/webhooks/CARD_ACTIVATED",
"protocol": "https",
"host": [
"sandbox",
"branchapp",
"com"
],
"path": [
"v1",
"organizations",
"{{organizationID}}",
"webhooks",
"CARD_ACTIVATED"
]
},
"description": "Triggered when a worker activates their card"
},
"response": []
},
{
"name": "Card Deactivated",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"employee_id\": \"123\",\n \"marqeta_card_token\": \"Acme_1099_Physical\",\n \"card_product\": \"Acme_1099\",\n \"card_type\": \"PHYSICAL\",\n \"reason_code\": \"LOST_OR_STOLEN\",\n \"time_emitted\": \"2023-12-30T15:40:32-08:00\"\n }\n\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://sandbox.branchapp.com/v1/organizations/{{organizationID}}/webhooks/CARD_DEACTIVATED",
"protocol": "https",
"host": [
"sandbox",
"branchapp",
"com"
],
"path": [
"v1",
"organizations",
"{{organizationID}}",
"webhooks",
"CARD_DEACTIVATED"
]
},
"description": "Triggered when a worker deactivates their card"
},
"response": []
},
{
"name": "Invoice Created",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"id\": 399742129664,\n \"amount\": 12456,\n \"description\": \"Invoice created for John Doe\",\n \"filename\": \"j_doe_invoice_11\",\n \"due_date\": \"2023-12-30\"\n}\n\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://sandbox.branchapp.com/v1/organizations/{{organizationID}}/webhooks/INVOICE_CREATED",
"protocol": "https",
"host": [
"sandbox",
"branchapp",
"com"
],
"path": [
"v1",
"organizations",
"{{organizationID}}",
"webhooks",
"INVOICE_CREATED"
]
},
"description": "Triggered when an invoice is created"
},
"response": []
},
{
"name": "Invoice Overdue",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"id\": 399742129664,\n \"amount\": 12456,\n \"description\": \"Invoice not paid by due dates\",\n \"due_date\": \"2023-12-30\"\n}\n\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://sandbox.branchapp.com/v1/organizations/{{organizationID}}/webhooks/INVOICE_OVERDUE",
"protocol": "https",
"host": [
"sandbox",
"branchapp",
"com"
],
"path": [
"v1",
"organizations",
"{{organizationID}}",
"webhooks",
"INVOICE_OVERDUE"
]
},
"description": "Triggered when an invoice is overdue"
},
"response": []
},
{
"name": "Invoice Transfer Initiated",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"invoice_id\": 399742129664,\n \"amount\": 12456,\n \"description\": \"Transferring invoice to XYZ\"\n}\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://sandbox.branchapp.com/v1/organizations/{{organizationID}}/webhooks/INVOICE_TRANSFER_INITIATED",
"protocol": "https",
"host": [
"sandbox",
"branchapp",
"com"
],
"path": [
"v1",
"organizations",
"{{organizationID}}",
"webhooks",
"INVOICE_TRANSFER_INITIATED"
]
},
"description": "Triggered when an invoice transfer is initiated"
},
"response": []
},
{
"name": "KYC Fallback Failed",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"employee_id\":\"123\"\n}\n\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://sandbox.branchapp.com/v1/organizations/{{organizationID}}/webhooks/KYC_FALLBACK_FAILED",
"protocol": "https",
"host": [
"sandbox",
"branchapp",
"com"
],
"path": [
"v1",
"organizations",
"{{organizationID}}",
"webhooks",
"KYC_FALLBACK_FAILED"
]
},
"description": "This webhook is triggered when KYC fallback ID upload verification has \nfailed. This means that the worker is not payable through Branch."
},
"response": []
},
{
"name": "KYC Declined",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"employee_id\": \"123\",\n \"reason\": \"Document invalid\"\n}\n\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://sandbox.branchapp.com/v1/organizations/{{organizationID}}/webhooks/KYC_DECLINED",
"protocol": "https",
"host": [
"sandbox",
"branchapp",
"com"
],
"path": [
"v1",
"organizations",
"{{organizationID}}",
"webhooks",
"KYC_DECLINED"
]
},
"description": "This webhook is triggered when a worker's KYC is declined."
},
"response": []
},
{
"name": "Payment Profile Activated",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"employee_id\": \"123\",\n \"active_type\": \"WALLET\",\n \"time_emitted\": \"2023-12-30T15:40:32-08:00\"\n}\n\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://sandbox.branchapp.com/v1/organizations/{{organizationID}}/webhooks/PAYMENT_PROFILE_ACTIVATED",
"protocol": "https",
"host": [
"sandbox",
"branchapp",
"com"
],
"path": [
"v1",
"organizations",
"{{organizationID}}",
"webhooks",
"PAYMENT_PROFILE_ACTIVATED"
]
},
"description": "This webhook is triggered when a payment method is added to a worker's account."
},
"response": []
},
{
"name": "Payment Profile Deactivated",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"employee_id\": \"123\",\n \"time_emitted\": \"2023-12-30T15:40:32-08:00\"\n}\n\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://sandbox.branchapp.com/v1/organizations/{{organizationID}}/webhooks/PAYMENT_PROFILE_DEACTIVATED",
"protocol": "https",
"host": [
"sandbox",
"branchapp",
"com"
],
"path": [
"v1",
"organizations",
"{{organizationID}}",
"webhooks",
"PAYMENT_PROFILE_DEACTIVATED"
]
},
"description": "This webhook is triggered when a payment method has been removed from a \nworker’s account, and the worker is no longer able to receive a \ndisbursement."
},
"response": []
},
{
"name": "Wallet Created",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"employee_id\": \"123\",\n \"account_number\": \"123456789\",\n \"routing_number\": \"084106768\",\n \"onboarding_link\": \"https://branchapp.com/ol1\"\n}\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://sandbox.branchapp.com/v1/organizations/{{organizationID}}/webhooks/WALLET_CREATED",
"protocol": "https",
"host": [
"sandbox",
"branchapp",
"com"
],
"path": [
"v1",
"organizations",
"{{organizationID}}",
"webhooks",
"WALLET_CREATED"
]
},
"description": "Triggered when the worker passes KYC and a wallet is created"
},
"response": []
},
{
"name": "Wallet Claimed",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"employee_id\":\"123\"\n}\n\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://sandbox.branchapp.com/v1/organizations/{{organizationID}}/webhooks/WALLET_CLAIMED",
"protocol": "https",
"host": [
"sandbox",
"branchapp",
"com"
],
"path": [
"v1",
"organizations",
"{{organizationID}}",
"webhooks",
"WALLET_CLAIMED"
]
},
"description": "Triggered when a worker downloads the application and claims a pre-initialized account"
},
"response": []
},
{
"name": "Wallet Activated",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"employee_id\": \"123\",\n \"account_number\": \"1234567891234567\",\n \"routing_number\": \"084106768\",\n \"onboarding_link\": \"https://branchapp.com/ol1\",\n \"is_claimed\": false\n}\n\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://sandbox.branchapp.com/v1/organizations/{{organizationID}}/webhooks/WALLET_ACTIVATED",
"protocol": "https",
"host": [
"sandbox",
"branchapp",
"com"
],
"path": [
"v1",
"organizations",
"{{organizationID}}",
"webhooks",
"WALLET_ACTIVATED"
]
},
"description": "When a worker's identity is verified a wallet is created. It is not \nusable however until the worker passes additional KYC checks. \nWhen the KYC checks pass, this webhook is triggered."
},
"response": []
},
{
"name": "Wallet Deactivated",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"employee_id\": \"123\",\n \"account_number\": \"1234567891234567\",\n \"routing_number\": \"084106768\",\n \"reason_code\": \"USER_REQUESTED\",\n \"reason\": \"Worker Resigned\",\n \"time_emitted\": \"2023-12-30T15:40:32-08:00\",\n \"is_claimed\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://sandbox.branchapp.com/v1/organizations/{{organizationID}}/webhooks/WALLET_DEACTIVATED",
"protocol": "https",
"host": [
"sandbox",
"branchapp",
"com"
],
"path": [
"v1",
"organizations",
"{{organizationID}}",
"webhooks",
"WALLET_DEACTIVATED"
]
},
"description": "This webhook is triggered when a worker's wallet is deactivated. \nThis could be due to Branch confirming fraud, or the worker requesting that their account be closed."
},
"response": []
},
{
"name": "Wallet Closed",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"employee_id\": \"123\",\n \"account_number\": \"1234567891234567\",\n \"routing_number\": \"084106768\"\n}\n\n",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://sandbox.branchapp.com/v1/organizations/{{organizationID}}/webhooks/WALLET_CLOSED",
"protocol": "https",
"host": [
"sandbox",
"branchapp",
"com"
],
"path": [
"v1",
"organizations",
"{{organizationID}}",
"webhooks",
"WALLET_CLOSED"
]
},
"description": "This webhook is triggered when a wallet is closed. The worker is reset and can onboard again."
},
"response": []
}
],
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{apiKey}}",
"type": "string"
},
{
"key": "key",
"value": "apiKey",
"type": "string"
}
]
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"exec": [
""
]
}
}
],
"variable": [
{
"key": "organizationID",
"value": "testOrganizationID"
},
{
"key": "apiKey",
"value": "testKey"
}
]
}
