Search Payment Transactions

URL

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

GET/payment-reporting/v1/payments/:id/transactions

Request Parameters

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

id

number

required

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:

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.

transactionStatus

TransactionStatus

Status of payment transaction confirmation See: Payment Item Confirmation Status

Values:

WAITING_FOR_APPROVAL

APPROVED

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

Values:

NO_REFUND

NOT_REFUNDED

PARTIAL_REFUNDED

FULLY_REFUNDED

payout

Payout

Payout details of merchant, sub-merchant and Craftgate distributed amounts for the payment transaction.

payoutStatus

PayoutStatus

Payout status for merchant and sub-merchant for the payment transaction.

Sample Codes

You can review the sample codes in the open source Craftgate API clients.import SampleCode from '@site/src/components/SampleCode'

Loading..