Clearing - Freedom Pay

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_clearing_amount

number

required

Clearing amount. If not specified

Example:

10

pg_salt

string

required

Random string.

Example:

some random string

pg_sig

string

required

Request signature.

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.freedompay.kg/do_capture.php' \
--form 'pg_merchant_id=""' \
--form 'pg_payment_id="12345"' \
--form 'pg_clearing_amount="10"' \
--form 'pg_salt="some random string"' \
--form 'pg_sig=""'

Responses

🟢200Success

application/xml

Body

pg_amount

number

required

Payment amount.

pg_clearing_amount

number

optional

Clearing amount. If not specified, the refund will be the full amount.

pg_status

string

required

Shows the result of the query. ok if the request is accepted for processing.
error otherwise.

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_amount>0</pg_amount>
  <pg_clearing_amount>0</pg_clearing_amount>
  <pg_status>string</pg_status>
  <pg_error_description>string</pg_error_description>
  <pg_salt>string</pg_salt>
  <pg_sig>string</pg_sig>
</root>