Refund

POST

https://api.freedompay.kg/revoke.php

Request

Body Params multipart/form-data

pg_merchant_id

string

required

Merchant ID in {{project}}. Issued upon connection.

pg_payment_id

integer

required

Internal payment identifier in the {{project}} system.

Example:

12345

pg_refund_amount

number

optional

Refund amount. If the parameter is not passed or 0 is passed

Example:

pg_salt

string

required

Random string.

Example:

some random string

pg_sig

string

required

Request signature.

pg_receipt_positions[0][count]

string

optional

Product quantity.

Example:

pg_receipt_positions[0][name]

string

optional

Product name.

Example:

Rug mouse

pg_receipt_positions[0][tax_type]

string

optional

Tax type. Possible values:
0 - Without tax,
1 - VAT 0%,
2 - VAT 12%,
3 - VAT 12/112,
4 - VAT 18%,
5 - VAT 18/118,
6 - VAT 10%,
7 - VAT 10/110,
8 - VAT 20%,
9 - VAT 20/120.

Example:

pg_receipt_positions[0][price]

string

optional

Price per unit product.

Example:

1000

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.freedompay.kg/revoke.php' \
--form 'pg_merchant_id=""' \
--form 'pg_payment_id="12345"' \
--form 'pg_refund_amount="50"' \
--form 'pg_salt="some random string"' \
--form 'pg_sig=""' \
--form 'pg_receipt_positions[0][count]="2"' \
--form 'pg_receipt_positions[0][name]="Rug mouse"' \
--form 'pg_receipt_positions[0][tax_type]="2"' \
--form 'pg_receipt_positions[0][price]="1000"'

Responses

🟢200Success

application/xml

Body

pg_status

string

required

Shows the result of the query.

pg_error_code

integer

optional

Error code.

pg_error_description

string

optional

The description of the error in the case of pg_status is error.

pg_salt

string

required

Random string.

pg_sig

string

required

Request signature.

Example

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <pg_status>string</pg_status>
  <pg_error_code>0</pg_error_code>
  <pg_error_description>string</pg_error_description>
  <pg_salt>string</pg_salt>
  <pg_sig>string</pg_sig>
</root>

Modified at 2025-02-03 10:08:06

Clearing

Status