Skip to main content

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.

URL

POST/settlement-reporting/v2/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;

settlementFileId
long

File id value created for settlement payout

settlementType
SettlementType

There are 3 different money transfer types available. If not sent, it defaults to SETTLEMENT see: Payout Types

Values:
SETTLEMENT
BOUNCED_SETTLEMENT
WITHDRAW
startDate
date
required

Start date for the time interval you want to query

endDate
date
required

End date for the time interval you want to query

page
number
required

Page number for pagination

size
number
required

Page size for pagination

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:

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

payoutDate
date

The date of 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

Values:
IBAN
WALLET
CROSS_BORDER
settlementSource
SettlementSource

The value indicates the source of payout. See: Payout Source

Values:
COLLECTION
WITHDRAW
BOUNCED

Sample Codes

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

Search Settlement Payout Completed Transactions

Loading..