Payout Webhook (Finnet -> Partner)
Webhook to notify the merchant about a payout result (success/failure).
Development
POST
PayoutWebhookUrlMerchant
V 1.0.0
Production
POST
PayoutWebhookUrlMerchant
V 1.0.0
Request
Header Request
Authorization
String
M
Basic Authentication header.
Example value: Basic dW5kZWZpbmVkOnBhc3N3b3Jk
accept
String
M
Media type. Use application/json.
Idempotency-key
String
M
A unique key to prevent processing duplicate requests. Can be your reference_id or any GUID.
for-user-id
String
M
Subaccount user ID that this transaction is for.
Body Request
1
reference_id
string
Yes
255
Client unique reference for this payout
2
channel_code
string
Yes
5
Destination bank channel code (example: 91014)
3
channel_properties
object
Yes
-
Destination account details
3.1
channel_properties.account_number
string
Yes
50
Destination account number
3.2
channel_properties.account_holder_name
string
Yes
255
Destination account holder name
4
amount
number
Yes
-
Payout amount (in the specified currency)
5
description
string
No
255
Optional payout note/description
6
currency
string
Yes
3
Currency code (ISO 4217), example: IDR
Sample Request
Response
Body Response
1
id
string
M
36
Unique payout ID generated by the system.
2
amount
number
M
-
Payout amount.
3
channel_code
string
M
5
Payout channel code.
4
currency
string
M
3
Currency code (ISO 4217).
5
reference_id
string
M
255
Merchant reference ID for this payout.
6
status
string
M
20
Payout status:
ACCEPTED
COMPLETED
FAILED
SUCCEEDED
CANCELLED
REVERSED
7
created
string (date-time)
M
24
Payout creation timestamp (ISO 8601).
8
updated
string (date-time)
M
24
Last payout update timestamp (ISO 8601).
9
estimated_arrival_time
string (date-time)
O
24
Estimated time the funds will arrive.
10
failure_code
string
O
50
Payout failure code (only when the payout fails).
11
business_id
string
M
36
Merchant/business ID.
12
channel_properties
object
M
-
Destination account details.
12.1
channel_properties.account_holder_name
string
M
255
Destination account holder name.
12.2
channel_properties.account_number
string
M
50
Destination account number.
12.3
channel_properties.account_type
string
O
20
Destination account type.
13
receipt_notification
object
O
-
Receipt notification settings.
13.1
receipt_notification.email_to
array[string]
O
-
Primary recipient email list.
13.2
receipt_notification.email_cc
array[string]
O
-
CC email list.
13.3
receipt_notification.email_bcc
array[string]
O
-
BCC email list.
14
metadata
object
O
-
Custom additional data from the merchant.
14.1
metadata.my_custom_id
string
O
255
Custom ID from the merchant.
14.2
metadata.my_custom_order_id
string
O
255
Custom order ID from the merchant.
Sample Response
Payout Webhook Status
1
ACCEPTED
The payout request has been accepted and has not yet been sent on to a channel. A payout may remain in this status if the chosen channel is currently offline.
2
REQUESTED
The payout has been sent to the channel. Funds have been sent to the channel for processing.
3
FAILED
Payout failed. See possible reasons in Failed Reasons section.
4
SUCCEEDED
Sender bank/channel has sent out the payout
5
CANCELLED
Payout has been cancelled per your request
6
REVERSED
Payout was rejected by the channel after the payout succeeded. Commonly due to invalid or dormant account.
Last updated