Freedom Pay
  1. Token
Freedom Pay
  • Gateway API
    • Introduction
    • Reference
      • Test cards
      • Error codes
    • Sync API
      • Introduction
      • Page
        • Introduction
        • Page
        • Page with amount control
        • Status
      • Pay
        • Introduction
        • Card
        • 3DSecure
        • Cancel
        • Clearing
        • Refund
        • Status
      • Payout
        • Introduction
        • Card
        • IBAN
        • Balance
        • Status
        • StatusV2
      • Transfer
        • Introduction
        • Card
        • 3DSecure
        • Rates
        • Status
      • Card
        • Introduction
        • Add
        • 3DSecure
        • List
        • Remove
        • Status
      • Token
        • Introduction
        • Token Pay
        • Apple Pay
        • Google Pay
        • Samsung Pay
        • Token Payout
        • Status
    • Async API
      • Introduction
      • create
        • create payment
        • create payment recurrent
      • read
        • read payment
        • read request
      • edit
        • edit payment.refund
        • edit payment.reverse
        • edit payment.clearing
      • delete
  • Merchant API
    • Introduction
    • Reference
      • Test cards
      • Test phone numbers
      • Error codes
    • Page
      • Introduction
      • Page
      • Page with amount control
      • Payout page
      • Frame
      • Widget
      • Status
    • Pay
      • Introduction
      • Cancel
      • Clearing
      • Refund
      • Status
    • Payout
      • Introduction
      • IBAN
      • Balance
      • Status by order_id
      • Status by Payment ID
      • Status by Payment ID V2
    • Mobile balance
      • Introduction
      • Init
      • Pay
      • Approve
      • Resend code
      • Status
    • Card
      • Introduction
      • Add
      • Add for payout
      • Remove
      • List
      • Status
    • Token
      • Introduction
      • Saved card with CVC input (Init)
        POST
      • Saved card with CVC input (Pay)
        POST
      • Non-acceptance payments
        POST
      • Non-acceptance payments (Pay)
        POST
      • Token payout
        POST
      • Status
        POST
    • Invoice
      • Introduction
      • Init
      • Info
      • Pay
      • Status
    • Additional
      • Introduction
      • Check request
      • Result notify
      • Payout notify
      • Redirect back
  • Card API
    • Introduction
    • Payment Cards
      • Reference
        • Request Status
        • Client product
        • Card product
        • Card status
        • Card block
        • Transaction
        • Error codes
      • Card issue
        • Bulk
        • Single
        • Physical
      • Card control
        • Activate
        • Block
        • Unblock
        • Set PIN
        • Reset PIN counter
        • Close
        • Identification
        • Info
        • Balance
        • Secret data
        • Statement
      • Client
        • Create
        • Edit
        • Card list
      • Additional
        • Request status
    • Gift Cards
      • Introduction
      • Reference
        • Request status
        • Card status
      • List
      • Issue
      • Confirm
      • Resend
      • Resend code
      • Status
  • Partner API
    • Rates
      • Introduction
      • Rates
    • Products
      • Introduction
      • Reference
        • Request
        • Product
        • Freedom POS
        • Freedom ECOM
        • Freedom BOX
        • Limits
      • Add user
      • Add product
      • Add user with product
      • Grant user
      • Send auth data
      • Request status
    • E-Money
      • Introduction
      • Reference
        • Request
        • Operation
        • Error codes
      • Add
      • Owner identification
      • Info
      • Close
      • Block
      • Balance
      • Statement
      • Request Status
    • Freedom ID
      • Introduction
      • Android SDK
      • iOS SDK
      • Reference
        • Error codes
      • Link
      • Token
      • Token refresh
      • Info
      • Profile
      • Request
  • Mobile SDK
    • Payment SDK
      • iOS
      • Android
    • Freedom QR
      • Reader SDK (Android)
      • Provider SDK (Android)
  • CMS
    • Introduction
    • Get Merchant ID and key
    • WordPress
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
      • Update
    • Tilda
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
    • InSales
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
    • Ecwid
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
    • Bitrix
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
    • PrestaShop
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
    • OpenCart
      • Introduction
      • Installation
      • Configuration
      • Test
      • Live payments
  1. Token

Token payout

POST
https://api.freedompay.uz/api/reg2reg

Request

Body Params multipart/form-data
pg_amount
number 
required
Transfer amount. Minimum 0.01.
Example:
10
pg_merchant_id
integer 
required
Merchant ID in {{project}}.
pg_order_id
string 
required
Order ID in the merchant system. A unique
Example:
order_1234
pg_user_id
integer 
required
User ID in the system.
Example:
1234
pg_card_id_to
integer 
required
ID of the card to transfer money to (returned when registering the card). Required if no pg_card_token_to.
Example:
1234
pg_card_token_to
string 
required
Token of the card to transfer money to (returned when registering the card). Required if no pg_card_id_to.
Example:
c92741d9-ddd7-4bad-abd0-5594a79eea1a
pg_description
string 
required
Payment description.
Example:
Payment Description
pg_post_link
string 
required
URL to which payment status response is sent.
Example:
http://site.kz/post
pg_order_time_limit
string 
required
Time limit for making a payment.
Example:
2020-12-31 12:00:00
pg_salt
string 
required
A random string consisting of arbitrary numbers and Latin letters.
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
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.freedompay.uz/api/reg2reg' \
--form 'pg_amount="10"' \
--form 'pg_merchant_id=""' \
--form 'pg_order_id="order_1234"' \
--form 'pg_user_id="1234"' \
--form 'pg_card_id_to="1234"' \
--form 'pg_card_token_to="c92741d9-ddd7-4bad-abd0-5594a79eea1a"' \
--form 'pg_description="Payment Description"' \
--form 'pg_post_link="http://site.kz/post"' \
--form 'pg_order_time_limit="2020-12-31 12:00:00"' \
--form 'pg_salt="some random string"' \
--form 'pg_sig=""'

Responses

🟢200Success
application/xml
Body
pg_payment_id
integer 
required
The unique identifier of the payment transaction in {{project}}. Serves as a key for all further work with the transaction.
pg_merchant_id
integer 
required
Merchant ID in the {{project}} system.
pg_status
string 
required
Request status.
Status Description:
ok: Request completed successfully.
error: Request completed with an error.
process: Final payment status need.
pg_order_id
string 
optional
Order ID in the merchant system.
pg_balance
number 
optional
Merchant's balance in the {{project}} system.
pg_card_hash
string 
optional
The card to which the payment was made.
pg_card_id
integer 
optional
Recipient's card ID.
pg_payment_amount
number 
optional
Payment amount.
pg_payment_date
string <date-time>
required
Date and time of the payment.
pg_error_code
integer 
optional
Error code.
pg_error_description
string 
optional
Description of the error.
pg_salt
string 
required
Random string consisting of arbitrary numbers and Latin letters.
pg_sig
string 
required
Request signature.
Example
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <pg_payment_id>0</pg_payment_id>
  <pg_merchant_id>0</pg_merchant_id>
  <pg_status>string</pg_status>
  <pg_order_id>string</pg_order_id>
  <pg_balance>0</pg_balance>
  <pg_card_hash>string</pg_card_hash>
  <pg_card_id>0</pg_card_id>
  <pg_payment_amount>0</pg_payment_amount>
  <pg_payment_date>2019-08-24T14:15:22Z</pg_payment_date>
  <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>
Previous
Non-acceptance payments (Pay)
Next
Status