Refund Previously Captured Transaction

post

https://api-test.qualpay.com/pg/refund/{pgIdOrig}

Returns money to the cardholder from a previously captured payment card transaction. You may request multiple refunds per captured transaction as long as the sum of all refunds does not exceed the original captured transaction amount. Authorizations that have not been captured are not eligible for a refund.

Note: Vendor accounts need special permissions to use this operation; contact Qualpay Support to enable it.

Path Params

pgIdOrig

string

required

Original transaction ID for the original authorization transaction, found as pg_id in the Authorize Transaction request response.

Body Params

Payment Gateway Refund Request

merchant_id

int64

required

Format: Variable length, up to 12 N
Description: Unique identifier in our system.

amt_tran

double

required

Format: Variable length, up to 12,2 N
Description: Total amount to refund. Partial refunds are allowed by providing an amount in this field that is less than the total original transaction amount.

developer_id

string

Format: Variable length, up to 32 AN
Description: Use to indicate which company developed the integration or the name of the payment solution that is connected to us. Suggested usage is softwareABCv1.0 or companyXYZv2.0.

echo_fields

string

Format: Variable length
Description: This field contains a JSON array of field data that will be echoed back in the response message.

loc_id

string

Format: Variable length, up to 4 N
Description: When a merchant has more than one location using the same currency, this value is used to specify the location for this request.

profile_id

string

Format: Fixed length, 20 N
Description: Explicitly identifies which Payment Gateway profile should be used for the request.

report_data

string

Format: Variable length
Description: This field contains a JSON array of field data that will be included with the transaction data reported in Merchant Manager.

session_id

string

INTERNAL USE ONLY.

user_id

int64

INTERNAL USE ONLY.

vendor_id

int64

Format: Fixed length, 10 N
Description: Identifies the vendor to which this request applies.
Conditional Requirement: This field is required for Qualpay partner accounts.

Responses

200Success

400Bad Request

401Unauthorized

402Declined

500Internal Server Error

509Timeout