Freedom Pay
  1. Transfer
Freedom Pay
  • Overview
  • Gateway API
    • Overview
    • Sync API
      • Overview
      • Purchase
        • Overview
        • Create payment
        • Any amount
        • Card
        • 3DSecure
        • Cancel
        • Clearing
        • Refund
        • Status
      • Payout
        • Overview
        • Card
        • IBAN
        • Balance
        • Status
      • Transfer
        • Overview
        • Card
          POST
        • 3DSecure
          POST
        • Rates
          POST
        • Status
          POST
      • Card
        • Overview
        • Add
        • 3DSecure
        • List
        • Remove
        • Status
      • Token
        • Overview
        • Token Pay
        • Apple Pay
        • Google Pay
        • Token Payout
        • Status
    • Async API
      • Overview
      • create
        • create payment
        • create payment recurrent
      • read
        • read payment
        • read request
      • edit
        • edit payment.refund
        • edit payment.reverse
        • edit payment.clearing
      • delete
  • Merchant API
    • Overview
    • Purchase
      • Overview
      • Checkout
      • Card token
        • Overview
        • Tokenize card
        • Delete token
        • Card token list
        • Create payment (with CVC)
        • Confirm payment (with CVC)
        • Create payment
        • Confirm payment
      • Create payment
      • Any amount
      • Cancel payment
      • Clearing
      • Refund payment
      • Status
    • Payout
      • Overview
      • Card token
        • Tokenize card
        • Delete token
        • Card token list
        • Create payment
      • Create payment
      • IBAN
      • Balance status
      • Status by order_id
      • Status by Payment ID
      • Status
    • Mobile balance
      • Overview
      • Init
      • Pay
      • Approve
      • Resend code
      • Status
    • Invoice
      • Overview
      • Init
      • Info
      • Pay
      • Status
    • SDK
      • JS SDK
      • Google Pay
      • Freedom QR
        • Reader SDK (Android)
        • Provider SDK (Android)
      • Payment SDK
        • iOS
        • Android
    • CMS
      • Overview
      • Get Merchant ID and key
      • WordPress
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
        • Update
      • Tilda
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • InSales
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • Ecwid
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • Bitrix
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • PrestaShop
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • OpenCart
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
    • Redirect back
      POST
    • Result notify
      POST
    • Payout notify
      POST
    • Check request
      POST
  • Card API
    • Overview
    • Payment Cards
      • Overview
      • Dictionaries
      • Bulk issue
      • Issue card
      • Issue plastic card
      • Activate card
      • Block card
      • Unblock card
      • Set PIN
      • Reset PIN counter
      • Close card
      • Update client
      • Card info
      • Balance
      • Secret data
      • Secret data (version 2)
      • Statement
      • Statement extended
      • Create client
      • Edit client
      • Сards' list
      • Request' status
      • Create transaction
      • Clearing transaction
      • Refund transaction
      • Transaction request' status
      • Transaction info
    • Gift Cards
      • Overview
      • List
      • Issue
      • Confirm
      • Resend
      • Resend code
      • Status
  • Partner API
    • Rates
      • Overview
      • Rates
    • Products
      • Overview
      • Dictionaries
      • Add client with product
      • Request status
    • E-Money
      • Overview
      • Add
      • Owner identification
      • Info
      • Close
      • Block
      • Balance
      • Statement
      • Request Status
    • Freedom ID
      • Overview
      • Design
      • iOS SDK
      • Android SDK
      • OAuth2
        • Authorization link
        • Token exchange
        • Token refresh
        • User info
        • Request profile
        • Get profile status
        • Create user
        • Update user
      • OIDC
        • Authorization endpoint
        • Token exchange
        • Userinfo
      • Error codes
      • Examples
        • Keycloak
    • Transfer
      • Overview
      • Get token
      • Refresh token
      • Get agents
      • Fees
      • Create person
      • Create business
      • Create transfer
      • Print application
      • Confirm
      • Search
      • Payout
      • Payout confirm
      • Cancel
      • Get person info
      • Get business info
      • Status
      • Info
    • Device ID
      • Android SDK
      • iOS SDK
  1. Transfer

Card

POST
https://api.freedompay.kz/g2g/p2p/transfer
This method uses card number for transfer
The transfer can follow two scenarios: with 3D Secure (3DS) or without it
The special token 2d0b504c-b95d-4cf6-b782-5a7d13ab2c85 is used to indicate which part of the translation should not be performed:
If the special token is passed in the pg_card_token parameter and pg_card_recipient is provided, only the payout will be processed. In this case, one of the parameters (pg_card_name or pg_card_recipient_name) is required
If the special token is passed in the pg_card_token parameter and pg_card_recipient_token is provided, only the payout will be processed
If the special token is passed in the pg_card_recipient_token parameter, only the receipt will be processed

Interaction diagram for non3ds transfer#

Status: success/error/pending
G2G_API_V3-Making a transfer (P2P) non 3DS.drawio.png

Request

Body Params multipart/form-data
pg_merchant_id
string 
required
Merchant ID in {{project}}
Issued upon connection
pg_order_id
integer 
required
Payment ID in the merchant system
It is recommended to keep this field unique
pg_amount
number 
required
Payment amount in pg_currency_from
>= 0.01
pg_amount_to
number 
optional
Payment amount in pg_currency_to
pg_currency_from
string 
required
The debit currency in which the transfer amount is indicated
pg_currency_to
string 
required
Currency of the transfer
pg_commission_amount
number 
optional
Commission charged from the payer
pg_description
string 
required
Payment description displayed to the buyer
pg_language
string 
optional
Error text language
pg_user_id
integer 
optional
User ID in the merchant system
pg_card_token
string 
optional
Saved card token of the sender
Required if no pg_card_pan
pg_card_pan
integer 
optional
Sender's card number
Required if no pg_card_token
pg_card_cvc
integer 
optional
CVC/CVV card password
Required if no pg_card_token
pg_card_year
integer 
optional
Card expiration year
Required if no pg_card_token
pg_card_month
integer 
optional
Card expiration month
Required if no pg_card_token
pg_card_name
string 
optional
Sender's cardholder name
Required if no pg_card_token
pg_card_recipient
integer 
optional
Recipient's card number
Required if no pg_card_recipient_token
pg_card_recipient_token
string 
optional
Recipient's saved card token
Required if no pg_card_recipient
pg_card_recipient_name
string 
optional
Recipient's cardholder name
pg_save_sender_card
string 
optional
Sign of the need to save the card for sending money
pg_save_recipient_card
string 
optional
Sign of the need to save the recipient's card
pg_salt
string 
required
A random string consisting of arbitrary numbers and Latin letters
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.kz/g2g/p2p/transfer' \
--form 'pg_merchant_id="";type=false' \
--form 'pg_order_id="";type=false' \
--form 'pg_amount="";type=false' \
--form 'pg_amount_to="";type=false' \
--form 'pg_currency_from="";type=false' \
--form 'pg_currency_to="";type=false' \
--form 'pg_commission_amount="";type=false' \
--form 'pg_description="";type=false' \
--form 'pg_language="";type=false' \
--form 'pg_user_id="";type=false' \
--form 'pg_card_token="";type=false' \
--form 'pg_card_pan="";type=false' \
--form 'pg_card_cvc="";type=false' \
--form 'pg_card_year="";type=false' \
--form 'pg_card_month="";type=false' \
--form 'pg_card_name="";type=false' \
--form 'pg_card_recipient="";type=false' \
--form 'pg_card_recipient_token="";type=false' \
--form 'pg_card_recipient_name="";type=false' \
--form 'pg_save_sender_card="";type=false' \
--form 'pg_save_recipient_card="";type=false' \
--form 'pg_salt="";type=false' \
--form 'pg_sig="";type=false'

Responses

🟢200Success
application/xml
Body
pg_payment_id
integer 
required
pg_status
string 
required
pg_payment_status
string 
optional
pg_3ds
boolean 
optional
pg_3d_acsurl
string 
optional
pg_order_id
string 
required
pg_payment_amount
number 
required
pg_payout_amount
number 
optional
pg_currency_from
string 
optional
pg_currency_to
string 
optional
pg_card_mask
string 
required
Saved card mask
pg_card_token
string 
optional
Saved card token
pg_card_recipient_token
string 
optional
Saved recipient card token
pg_card_recipient_mask
string 
optional
Recipient card mask
pg_payment_date
string 
required
pg_datetime
string 
required
pg_salt
string 
required
pg_sig
string 
required
Example
<?xml version="1.0" encoding="utf-8"?>
<response>
    <pg_payment_id>7777777777</pg_payment_id>
    <pg_status>ok</pg_status>
    <pg_payment_status>success</pg_payment_status>
    <pg_3ds>1</pg_3ds>
    <pg_3d_acsurl>https://bank-issuer-url.com/3ds-verify</pg_3d_acsurl>
    <pg_order_id>ORD12345</pg_order_id>
    <pg_payment_amount>1000.00</pg_payment_amount>
    <pg_payout_amount>950.00</pg_payout_amount>
    <pg_currency_from>KZT</pg_currency_from>
    <pg_currency_to>USD</pg_currency_to>
    <pg_card_token>abcd1234token</pg_card_token>
    <pg_card_recipient_token>xyz9876token</pg_card_recipient_token>
    <pg_card_mask>411111-XXXXXX-1111</pg_card_mask>
    <pg_card_recipient_mask>422222-XXXXXX-2222</pg_card_recipient_mask>
    <pg_payment_date>2024-09-02T12:19:01+00:00</pg_payment_date>
    <pg_salt>YtfwCGiBHsFLpYGk</pg_salt>
    <pg_sig>ccee466c01c2332d8a065d6108fd686b</pg_sig>
    <pg_datetime>2024-09-02T12:19:01+00:00</pg_datetime>
</response>
🟢200Process
🟢200Error
🟢200Invalid Signature
Previous
Overview
Next
3DSecure