v1

latestOpenAPI 3.0.32026-07-23167675.4 KB

API Payout

Payout Initiate

Create a Payout Link transaction through API

post/v1/payout/initiate

Signaturestring required

Algorithm symmetric signature HMAC_SHA512 (clientSecret, stringToSign)

Request-Timestampstring utc timestamp required

Client's current local time in yyyy-MM-ddTHH:mm:ssTZD format

Client-Idstring required

Unique ID for a partner (DOKU'S Client ID)

Request-Idstring required

Numeric String. Reference number that should be unique in the same day (request-id)

amountnumber required

Transaction Amount. Total Amount with 2 decimal, format ISO 4217 | min length: 1 | max length: 16.2

sender_namestring required

Sender Name | min length: 1 | max length: 50

receiver_namestring required

Beneficiary / Receiver Name | min length: 1 | max length: 50

receiver_phone_numberstring required

Beneficiary / Receiver Phone, Format: 62xxxxxxxxx xxxx | min length: 9 | max length: 14

receiver_emailstring required

Beneficiary / Receiver Email | min length: 1 | max length: 50

reference_idstring required

Unique Reference number from merchant | min length: 1 | max length: 30

descriptionstring

Decription min length: 1 | max length: 30

currencystring

Currency | min length: 1 | max length: 3

item created

statusstring required

status code

messagestring required

status message

timestampstring utc timestamp

Doku's response time in yyyy-MM-ddTHH:mm:ssTZD format