Payout
These are the events for which webhooks will be triggered
Payout status specific events
| Event | Description | Default |
|---|---|---|
payout.requires_approval | Triggered when the status is requires_approval | Off |
payout.requires_action | Triggered when the status is requires_action | Off |
payout.requirs_funding | Triggered when the status is requires_funding | On |
payout.processing | Triggered when the status is processing | Off |
payout.succeeded | Triggered when the status is succeeded | On |
payout.failed | Triggered when the status is failed | On |
payout.cancelled | Triggered when the payout is cancelled | On |
Other Events
| Event | Description | Default (On / Off) |
|---|---|---|
payout.created | Triggered when a payout is created | Off |
Sample Events
payout.created
{
"type": "payout.created",
"id": "evt_ctbvv9o1l435sdu911tg",
"object": "event",
"created_at": "2024-12-10T08:45:27.349281559Z",
"data": {
"created_at": "2024-12-10T08:45:25.12005Z",
"beneficiary_details": {
"destination_details": {
"bank": {
"bank_codes": {
"bank_code": "INGBAU2SXXX",
"branch_code": "INGBAU2SXXX"
},
"bank_name": "Central Bank",
"country": "BR",
"currency": "BRL",
"account_type": "savings"
},
"type": "bank"
},
"phone": {
"calling_code": "55"
},
"name": "Roman",
"email": "[email protected]",
"type": "individual",
"tax_id": "123.456.789-87"
},
"payout_fx_transaction": {
"initial": {
"currency": "BRL",
"amount": 10000
},
"final": {
"currency": "BRL",
"amount": 10000
},
"id": "fx_ctbvv905ha8onnfg24s0",
"object": "fx_transaction",
"exchange_rate": 1
},
"type": "local",
"status": "processing",
"purpose": "PYR001",
"id": "pot_ctbvv96hi567m07e7q40",
"holding_currency": "INR",
"currency": "BRL",
"beneficiary": "bnf_cs8bf4m6rf9979b4isq0",
"object": "payout",
"balance_transaction": "btr_ctbvv9ehi567m07e7q80",
"amount": 10000
}
}
payout.processing
{
"type": "payout.processing",
"id": "evt_ctbvv9o1l435sdu911t0",
"object": "event",
"created_at": "2024-12-10T08:45:27.305264108Z",
"data": {
"created_at": "2024-12-10T08:45:25.12005Z",
"beneficiary_details": {
"destination_details": {
"bank": {
"bank_codes": {
"bank_code": "INGBAU2SXXX",
"branch_code": "INGBAU2SXXX"
},
"bank_name": "Central Bank",
"country": "BR",
"currency": "BRL",
"account_type": "savings"
},
"type": "bank"
},
"phone": {
"calling_code": "55"
},
"name": "Test1",
"email": "[email protected]",
"type": "individual",
"tax_id": "123"
},
"payout_fx_transaction": {
"initial": {
"currency": "BRL",
"amount": 10000
},
"final": {
"currency": "BRL",
"amount": 10000
},
"id": "fx_ctbvv905ha8onnfg24s0",
"object": "fx_transaction",
"exchange_rate": 1
},
"type": "local",
"status": "processing",
"purpose": "PYR001",
"id": "pot_ctbvv96hi567m07e7q40",
"holding_currency": "INR",
"currency": "BRL",
"beneficiary": "bnf_cs8bf4m6rf9979b4isq0",
"object": "payout",
"balance_transaction": "btr_ctbvv9ehi567m07e7q80",
"amount": 10000
}
}
payout.succeeded
{
"type": "payout.succeeded",
"id": "evt_ctc007o1l435sdu91250",
"object": "event",
"created_at": "2024-12-10T08:47:27.446050128Z",
"data": {
"tracking_details": {
"tracking_number": "UETR20240311001",
"tracking_type": "uetr"
},
"created_at": "2024-12-10T08:45:25.12005Z",
"beneficiary_details": {
"destination_details": {
"bank": {
"bank_codes": {
"bank_code": "INGBAU2SXXX",
"branch_code": "INGBAU2SXXX"
},
"bank_name": "Central Bank",
"country": "BR",
"currency": "BRL",
"account_type": "savings"
},
"type": "bank"
},
"phone": {
"calling_code": "55"
},
"name": "Test1",
"email": "[email protected]",
"type": "individual",
"tax_id": "123"
},
"payout_fx_transaction": {
"initial": {
"currency": "BRL",
"amount": 10000
},
"final": {
"currency": "BRL",
"amount": 10000
},
"id": "fx_ctbvv905ha8onnfg24s0",
"object": "fx_transaction",
"exchange_rate": 1
},
"type": "local",
"status": "succeeded",
"purpose": "PYR001",
"id": "pot_ctbvv96hi567m07e7q40",
"holding_currency": "INR",
"currency": "BRL",
"beneficiary": "bnf_cs8bf4m6rf9979b4isq0",
"object": "payout",
"balance_transaction": "btr_ctbvv9ehi567m07e7q80",
"amount": 10000
}
}
payout.requires_funding
{
"type": "payout.requires_funding",
"id": "evt_ctc02681l435sdu912pg",
"object": "event",
"created_at": "2024-12-10T08:51:37.346373409Z",
"data": {
"created_at": "2024-12-10T08:51:34.128328Z",
"beneficiary_details": {
"address": {
"line1": "MG Road",
"line2": "Adj ST Mary School",
"postal_code": "10038",
"city": "Delhi",
"state": "Delhi",
"country": "IN"
},
"destination_details": {
"bank": {
"bank_codes": {
"ifsc_code": "HDFR8897CA",
"swift_code": "INGBAU2SXXX"
},
"account_number": "1276472008763",
"bank_name": "hdfc",
"country": "IN",
"currency": "INR",
"purpose_code": "Test",
"firc_required": true
},
"type": "bank"
},
"phone": {
"calling_code": "91"
},
"name": "test",
"email": "[email protected]",
"type": "individual"
},
"payout_fx_transaction": {
"initial": {
"currency": "INR",
"amount": 1000000000
},
"final": {
"currency": "INR",
"amount": 1000000000
},
"id": "fx_ctc025g5ha8onnfg2510",
"object": "fx_transaction",
"exchange_rate": 1
},
"type": "local",
"status": "requires_funding",
"purpose": "PYR001",
"id": "pot_ctc025mhi567m07e7r50",
"holding_currency": "GBP",
"currency": "INR",
"beneficiary": "bnf_crv7k31h1l071n2fkbjg",
"object": "payout",
"amount": 1000000000
}
}
payout.requires_approval
{
"type": "payout.requires_approval",
"id": "evt_ctc0bit3iqh25ihhl1bg",
"object": "event",
"created_at": "2024-12-10T09:11:39.659702396Z",
"data": {
"created_at": "2024-12-10T09:11:37.418151Z",
"beneficiary_details": {
"destination_details": {
"bank": {
"bank_codes": {
"swift_code": "INGBAU2SXXX"
},
"account_number": "1234675423679987",
"bank_name": "Central Bank",
"country": "US",
"currency": "SGD"
},
"type": "bank"
},
"phone": {
"calling_code": "1"
},
"name": "aaaaa",
"type": "business"
},
"payout_fx_transaction": {
"initial": {
"currency": "SGD",
"amount": 1000
},
"final": {
"currency": "SGD",
"amount": 1000
},
"id": "fx_ctc0bidpk5p8ci8rf57g",
"object": "fx_transaction",
"exchange_rate": 1
},
"type": "swift",
"status": "requires_approval",
"charge_type": "ours",
"purpose": "PYR001",
"id": "pot_ctc0bidf9sjsk2si3qpg",
"holding_currency": "AUD",
"currency": "SGD",
"beneficiary": "bnf_crqfjhsbvd1o6tv0gku0",
"object": "payout",
"statement_descriptor": "Muskan",
"on_behalf_of": "ent_csorc2c1kl1roj58r2hg",
"amount": 1000
}
}
payout.failed
{
"type": "payout.failed",
"id": "evt_ctc145tvggacf0fci0a0",
"object": "event",
"created_at": "2024-12-10T10:04:07.654463614Z",
"data": {
"tracking_details": {
"tracking_number": "67543890",
"tracking_type": "utr"
},
"created_at": "2024-12-10T09:15:59.251488Z",
"beneficiary_details": {
"destination_details": {
"bank": {
"bank_codes": {
"swift_code": "INGBAU2SXXX"
},
"account_number": "1234562787358912",
"bank_name": "Central Bank",
"country": "US",
"currency": "SGD"
},
"type": "bank"
},
"phone": {
"calling_code": "1"
},
"name": "Roman",
"type": "business"
},
"payout_fx_transaction": {
"initial": {
"currency": "SGD",
"amount": 100
},
"final": {
"currency": "SGD",
"amount": 100
},
"id": "fx_ctc0djtpk5p8ci8rf700",
"object": "fx_transaction",
"exchange_rate": 1
},
"type": "swift",
"status_description": "PO1008 entity_approval_rejected",
"status": "failed",
"charge_type": "ours",
"purpose": "PYR003",
"id": "pot_ctc0djtf9sjsk2si3uf0",
"holding_currency": "AUD",
"currency": "SGD",
"beneficiary": "bnf_crqfjhsbvd1o6tv0gku0",
"object": "payout",
"statement_descriptor": "Muskan",
"on_behalf_of": "ent_ct2ovl9f5lhf6huap5cg",
"amount": 100
}
}
payout.cancelled
{
"type": "payout.cancelled",
"id": "evt_ctgjf5ncu42kd3rmm3r0",
"object": "event",
"created_at": "2024-12-17T08:34:30.98072183Z",
"data": {
"created_at": "2024-12-17T08:33:48.059177Z",
"beneficiary_details": {
"address": {
"line1": "MG Road",
"line2": "Adj ST Mary School",
"postal_code": "10038",
"city": "Delhi",
"state": "Delhi",
"country": "IN"
},
"destination_details": {
"bank": {
"bank_codes": {
"aba_code": "123478789",
"swift_code": "INGBAU2SXXX"
},
"account_number": "1234456775333",
"bank_name": "CityBank",
"country": "US",
"currency": "USD"
},
"type": "bank"
},
"phone": {
"calling_code": "1",
"number": "12312312312"
},
"name": "Test 7",
"email": "[email protected]",
"type": "individual",
"tax_id": "1234123"
},
"payout_fx_transaction": {
"initial": {
"currency": "USD",
"amount": 100000
},
"final": {
"currency": "USD",
"amount": 100000
},
"id": "fx_ctgjeqtpk5p8ci903jcg",
"object": "fx_transaction",
"exchange_rate": 1
},
"type": "local",
"status": "cancelled",
"purpose": "PYR001",
"id": "pot_ctgjeqvg9n1vh5nsb3ng",
"holding_currency": "AUD",
"currency": "USD",
"beneficiary": "bnf_crv5o44fd64iheof2r70",
"object": "payout",
"statement_descriptor": "erf",
"on_behalf_of": "ent_ctdv4tt97ubkibq2km2g",
"amount": 100000
}
}
payout.requires_action
{
"type": "payout.requires_action",
"id": "evt_ctgll361mt84a8u1dvgg",
"object": "event",
"created_at": "2024-12-17T11:03:41.089728899Z",
"data": {
"tracking_details": {
"tracking_number": "566975432",
"tracking_type": "utr"
},
"created_at": "2024-12-17T08:42:14.107051Z",
"beneficiary_details": {
"address": {
"line1": "MG Road",
"line2": "Adj ST Mary School",
"postal_code": "10038",
"city": "Delhi",
"state": "Delhi",
"country": "IN"
},
"destination_details": {
"bank": {
"bank_codes": {
"aba_code": "123478789",
"swift_code": "INGBAU2SXXX"
},
"account_number": "Test7",
"bank_name": "CityBank",
"country": "US",
"currency": "USD"
},
"type": "bank"
},
"phone": {
"calling_code": "1",
"number": "12312312312"
},
"name": "Roman",
"email": "[email protected]",
"type": "individual",
"tax_id": "911-92-3333"
},
"payout_fx_transaction": {
"initial": {
"currency": "USD",
"amount": 1000
},
"final": {
"currency": "USD",
"amount": 1000
},
"id": "fx_ctgjipdpk5p8ci903nt0",
"object": "fx_transaction",
"exchange_rate": 1
},
"type": "local",
"status": "requires_action",
"purpose": "PYR003",
"id": "pot_ctgjipfg9n1vh5nsbcug",
"holding_currency": "USD",
"currency": "USD",
"beneficiary": "bnf_crv5o44fd64iheof2r70",
"object": "payout",
"statement_descriptor": "Muskan",
"balance_transaction": "btr_ctgjipng9n1vh5nsbd20",
"on_behalf_of": "ent_ctc0kk9sgkgeelcl87i0",
"amount": 1000
}
}
Updated 4 days ago