Skip to main content

Refund Payment

Refund of a payment is marked as a cancel for certain situations and a refund for other certain situations.

CANCEL: If the refund request is made on the same day the payment was made and there is no partial refund of this payment previously made, while responding, refundType returns CANCEL, id information exists and the paymentTransactionRefunds list is empty.

REFUND: If a partial refund has been made before, or if the refund request is made on a different day than the day the payment was made, while responding, refundType returns REFUND, id information does not exist and paymentTransactionRefunds list is full (includes information about each partial refund).

URL​

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

POST/payment/v1/refunds

Request Parameters​

The parameters expected to be sent in the requests to be made to refund are listed under the table and sub-headings below.

paymentId
number
required

ID of the payment that that requested to be refunded

conversationId
string

"boomerang" value that can be sent with the request and received with the response. This value is not the main value at which the return will occur, but an informative value that can be used to link the return request with different requests. Usually, the order number is used that is stored in merchant own system.

refundDestinationType
RefundDestinationType

See: Refund Type

Values:
PROVIDER
WALLET
chargeFromMe
boolean

Should the refund is charged by using merchant's balance? Can be used in case of insufficient sub-merchant balance in marketplace payment

Response Parameters ​

id
number

ID of the refund

conversationId
string

Value of theconversationId parameter sent in the payment initiation request

createdDate
date

The date that the payment is refunded

status
string

See: Refund Status Type

refundPrice
decimal

Price of the refund

refundBankPrice
decimal

Bank price of the refund

refundWalletPrice
decimal

Wallet price of the refund

refundType
string

Returns CANCEL if cancelled and REFUND if refunded

refundDestinationType
RefundDestinationType

See: Refund Type

Values:
PROVIDER
WALLET
authCode
string

authCode value retrieved from bank for the refund

hostReference
string

hostReference value retrieved from bank for the refund

transId
string

transId value retrieved from bank for the refund

currency
Currency

Currency of the refund. See: Currencies

Values:
TRY
USD
EUR
GBP
CNY
ARS
BRL
AED
IQD
AZN
KZT
KWD
SAR
BHD
RUB
JPY
EGP
paymentId
number

ID of the payment of to be refunded

paymentTransactionRefunds
PaymentTransactionRefundResponse[]

It is the object that contains information about the transaction of the refunded payment

Sample Codes​

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

Java.NETPHPNode.jsGo