Payout Completed Transactions

If you are working in the marketplace model, you can inquire about the payout you have made for yourself and your sub-merchants via this endpoint.


POST /settlement-reporting/v1/settlement-file/payout-completed-transactions

Request Parameters

The expected parameters to be sent in requests to query payout completed transactions are listed under the table and subheadings below;

Parameter Name Type Mandatory Description
settlementFileId long No File id value created for settlement payout
settlementType SettlementType No There are 3 different money transfer types available. If not sent, it defaults to SETTLEMENT see: Payout Types
startDate date Yes Start date for the time interval you want to query
endDate date Yes End date for the time interval you want to query

Response Parameters

Parameters returned as a result of querying payout completed transactions are also subject to the rules specified in the Response Formats section of the API documentation home page. In the absence of a systematic or fictional error, the sub-parameters of the object returned in the data/items parameter are as follows:

Parameter Name Type Description
payoutId number Payout operation id value. Using this value, you can query the payout detail
transactionId number The id value of the transaction subject to the payout
transactionType PayoutTransactionType Type of transaction subject to payout. See: Payout Transaction Type
payoutAmount decimal Sent amount for payout
currency string Currency value
merchantId string The id value of the member to whom the money is sent
merchantType string Type of member to whom money is sent. See: Payout Merchant Types
settlementEarningsDestination SettlementEarningsDestination The destination where the money is sent. See: Payout Destination
settlementSource SettlementSource The value indicates the source of payout. See: Payout Source

Sample Codes

You can review the sample codes in the open source Craftgate API clients.

Search Settlement Payout Completed Transactions