block-quote chevron-down
copy Copy chevron-down
Payout Payout Link Handling payouts can be operationally complex, particularly when it involves collecting and managing bank account details from multiple recipients. To streamline this process, DOKU provides a feature called Payout Link. This feature allows merchants to send bonuses and commissions to their employees.
With Payout Link, merchants are not required to manually collect or input beneficiary bank account information. Instead, DOKU automatically generates and sends a secure link to each beneficiary via email. The recipient can then submit their banking details directly through this link at their convenience.
Integration Steps
Here is the overview of how to integrate with Payout Link:
Payout Link Status Mapping
Here is the possible value of Payout Link Status and the description:
Payout link initiated successfully.
Payout link email notification is sent.
Payout link opened through email.
Payout link confirmation process has failed and will be retried.
Payout link is confirmed, payment/remit request is sent to beneficiary and on process.
Payout link payment/remit request has been processed successfully.
Payout link payment/remit request has been retried 3 times and still failed.
Payout link is expired because it's never opened.
API Specification
Payout Initiate
post
https://{api-domain} /v1/payout/initiate Create a Payout Link transaction through API
Signature string Required Algorithm symmetric signature HMAC_SHA512 (clientSecret, stringToSign)
Example: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5 Request-Timestamp string · utc timestamp Required Client's current local time in yyyy-MM-ddTHH:mm:ssTZD format
Example: 2020-12-21T07:50:11Z Client-Id string Required Unique ID for a partner (DOKU'S Client ID)
Example: 821508239190 Request-Id string Required Numeric String. Reference number that should be unique in the same day (request-id)
Example: 418075533589 Body
application/json chevron-down application/json
amount number Required Transaction Amount. Total Amount with 2 decimal, format ISO 4217 | min length: 1 | max length: 16.2
Example: 11500 sender_name string Required Sender Name | min length: 1 | max length: 50
Example: Firman receiver_name string Required Beneficiary / Receiver Name | min length: 1 | max length: 50
Example: Toru Yamashita receiver_phone_number string Required Beneficiary / Receiver Phone, Format: 62xxxxxxxxx xxxx | min length: 9 | max length: 14
Example: 0816291271826 receiver_email string Required Beneficiary / Receiver Email | min length: 1 | max length: 50
Example: [email protected] reference_id string Required Unique Reference number from merchant | min length: 1 | max length: 30
Example: PAY_83921251 description string Optional Decription min length: 1 | max length: 30
Example: Payout for bonus 2023 currency string Optional Currency | min length: 1 | max length: 3
Example: IDR status string Required Example: 0 message string Required Example: Success timestamp string · utc timestamp Optional Doku's response time in yyyy-MM-ddTHH:mm:ssTZD format
Example: 2020-12-21T07:56:11.000Z data object Required
Show properties plus
post
https://{api-domain} /v1/payout/status Check Payout Link current status through API
Signature string Required Algorithm symmetric signature HMAC_SHA512 (clientSecret, stringToSign)
Example: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5 Request-Timestamp string · utc timestamp Required Client's current local time in yyyy-MM-ddTHH:mm:ssTZD format
Example: 2020-12-21T07:50:11Z Client-Id string Required Unique ID for a partner (DOKU'S Client ID)
Example: 821508239190 Request-Id string Required Numeric String. Reference number that should be unique in the same day (request-id)
Example: 418075533589 Body
application/json chevron-down application/json
transaction_id string Required Must be the same as reference_id given in the payout initiate request | min length: 1 | max length: 30
Example: PAY_83921251 status string Required Example: 0 message string Required Example: Success timestamp string · utc timestamp Optional Doku's response time in yyyy-MM-ddTHH:mm:ssTZD format
Example: 2020-12-21T09:01:11.000+07:00 data object Required
Show properties plus
Last updated 5 months ago
