Retrieve Payment Refunds

URL

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

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

Request Parameters

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

id

number

required

ID of payment 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

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. See: Refund Type

refundPrice

decimal

Refunded amount

refundBankPrice

decimal

Refunded bank amount

refundWalletPrice

decimal

Refunded wallet amount

conversationId

string

conversationId value that sent in payment refund request by merchant

authCode

string

authCode value of the payment related to the refund

hostReference

string

hostReference value of the payment related to the refund

transId

string

transId value of the payment related to the refund

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

paymentId

number

ID of payment for the refund

Sample Codes

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

Java.NETPHPNode.jsGo