Retrieve Transaction Refunds

URL

The endpoint and http method information to inquiry refund with payment transaction are stated below.

GET/payment-reporting/v1/payments/:paymentId/transactions/:paymentTransactionId/refunds

Request Parameters

Refund inquiry with payment transaction can only be made using the payment ID.

paymentId

number

required

ID of payment that requested to be retrieved

paymentTransactionId

number

required

ID of payment transaction that requested to be retrieved

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

ID of refund item

createdDate

date

Date and time that refund is done

status

RefundStatus

Returns SUCCESS for successful refunds; FAILURE for failed refunds

Values:

SUCCESS

FAILURE

WAITING

refundDestinationType

string

If refund destination is card or payment provider, this value returns as PROVIDER. If refund destination is wallet, this value returns as WALLET.

refundPrice

decimal

Refunded amount for payment item

refundBankPrice

decimal

Refunded bank amount for payment item

refundWalletPrice

decimal

Refunded wallet amount for payment item

conversationId

string

conversationId` value that sent in payment refund request by merchant

authCode

string

authCode value of the payment transaction related to the refund

hostReference

string

hostReference value of the payment transaction related to the refund

transId

string

transId value of the payment transaction related to the refund

isAfterSettlement

boolean

Whether the refund is after the payout

paymentType

PaymentType

See: Payment Types

Values:

CARD_PAYMENT

DEPOSIT_PAYMENT

WALLET_PAYMENT

CARD_AND_WALLET_PAYMENT

BANK_TRANSFER

APM

error

PaymentError

Error detail info, returns if the refund is failed. See: Payment Error Groups

paymentTransactionId

number

ID of payment transaction for the refund

Sample Codes

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

Java.NETPHPNode.jsGo