Search Payment Transactions

URL

The endpoint and http method information to query payment transaction in detail are stated below.

HTTP Method	URL
`GET`	`/payment-reporting/v1/payments/:id/transactions`

Request Parameters

Payment transaction detail query can only be made using the payment ID value.

Parameter Name	Type	Required	Description
`id`	`number`	Yes	Payment transacton ID to search

Response Parameters

The parameters returned as a result of the payment are also subject to the rules specified in the Response Formats section of the API documentation home page. The object structure in the response is as follows:

Parameter Name	Type	Description
`id`	`number`	Payment transaction ID
`name`	`string`	The product or service name for the payment transaction description that sent in payment request
`externalId`	`string`	External ID value for the payment transaction sent in the payment request
`createdDate`	`date`	Create date that the payment request sent
`price`	`decimal`	Price for the payment transaction
`paidPrice`	`decimal`	Collected paid amount share of full paid amount for the payment transaction
`walletPrice`	`decimal`	Amount share collected from wallet of full collected wallet amount for the payment transaction
`refundablePrice`	`string`	Refundable amount
`merchantCommissionRate`	`decimal`	Interest rate to calculate paid price that buyer will pay
`merchantCommissionRateAmount`	`decimal`	Shared interest amount of the payment transaction
`bankCommissionRate`	`string`	Bank commission rate
`bankCommissionRateAmount`	`string`	Bank commission rate amount
`merchantPayoutAmount`	`decimal`	Payout amount share that will be sent to merchant for the payment transaction
`subMerchantMemberId`	`number`	Sub-merchant ID related to payment transaction
`subMerchantMemberPrice`	`decimal`	Amount share of the sub-merchant for the payment transaction
`subMerchantMemberPayoutRate`	`decimal`	Ratio of the amount share to be sent to the sub-merchant regarding the amount share to be sent to the merchant.
`subMerchantMemberPayoutAmount`	`decimal`	Amount share that will be payout for the payment transaction
`subMerchantMember`	`MemberResponse`	Sub-merchant details of payment transaction See: Seller Information
`transactionStatus`	`TransactionStatus`	Status of payment transaction confirmation (See: Payment Item Confirmation Status
`transactionStatusDate`	`date`	Date that transaction status updated
`blockageResolvedDate`	`date`	Date that the blockage will be resolved
`refundStatus`	`PaymentRefundStatus`	Refund status of payment transaction see: Payment Refund Status
`payout`	`Payout`	Payout details of merchant, sub-merchant and Craftgate distributed amounts for the payment transaction See: Payment Transaction Distribution of Money Transfer
`payoutStatus`	`PayoutStatus`	Payout status for merchant and sub-merchant for the payment transaction See: Payment Transaction Money Transfer Status

Payment Transaction Distribution of Money Transfer

It includes the distribution of the share of the money transfer to be made in relation to the payment, in terms of a specific a transaction, between the merchant and the sub-merchant.

The currency of the money distribution is always TRY.

Parameter Name	Type	Description
`paidPrice`	`decimal`	Collected amount share for the payment transaction
`currency`	`Currency`	See: Currencies
`merchantPayoutAmount`	`decimal`	Payout amount share of merchant for the payment transaction (in TRY currency)
`subMerchantMemberPayoutAmount`	`decimal`	Payout amount share of sub-merchant for the payment transaction (in TRY currency)
`parity`	`decimal`	Parity info for the payment transaction
`bankCommissionRateAmount`	`decimal`	Bank commission amount for the payment transaction

Payment Transaction Money Transfer Status

It includes the money sending status for the merchant and the sub-merchant regarding the payment transaction.

Parameter Name	Type	Description
`merchantStatus`	`TransactionPayoutStatus`	Status of payout transaction to merchant See: Payout Status
`merchantStatusDate`	`date`	The status date of payout transation to merchant
`subMerchantMemberStatus`	`TransactionPayoutStatus`	Status of payout transaction to sub-merchant See: Payout Status
`subMerchantMemberStatusDate`	`date`	The status date of payout transation to sub-merchant

Sample Codes

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