Freedom Pay

Cancel

POST

https://api.freedompay.kz/g2g/cancel

Cancel payment before the actual fund withdrawal is available only for a two-step payment process

Payment cancellation is made before funds are debited, at the stage of holding the amount on the payer's card

Interaction diagram

Status: success/error/pending

Request

Body Params multipart/form-data

pg_merchant_id

integer

required

Merchant ID in {{project}}
Issued upon connection

pg_payment_id

integer

required

Transaction ID

pg_salt

string

required

Random string consisting of arbitrary numbers and Latin letters

pg_sig

string

required

Request signature

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.freedompay.kz/g2g/cancel' \
--form 'pg_merchant_id=""' \
--form 'pg_payment_id=""' \
--form 'pg_salt=""' \
--form 'pg_sig=""'

Responses

🟢200Success

application/xml

Body

pg_payment_id

integer

required

Transaction ID

pg_payment_revoke_id

integer

required

Cancellation transaction ID

pg_status

string

required

Request status

pg_revoke_status

string

required

Payment cancellation status

pg_salt

string

required

Random string

pg_sig

string

required

Digital signature of the request

Example

<?xml version="1.0" encoding="utf-8"?>
<response>
    <pg_payment_id>7777777777</pg_payment_id>
    <pg_payment_revoke_id>7777777778</pg_payment_revoke_id>
    <pg_status>ok</pg_status>
    <pg_revoke_status>success</pg_revoke_status>
    <pg_salt>YtfwCGiBHsFLpYGk</pg_salt>
    <pg_sig>ccee466c01c2332d8a065d6108fd686b</pg_sig>
</response>

🟢200Error

🟢200Invalid Signature

3DSecure

Clearing

Cancel

Interaction diagram#

Request

Request samples

Responses

Interaction diagram