1. Payouts
Freedom Pay
  • Overview
  • Gateway API
    • Overview
    • Sync API
      • Overview
      • Card data encryption
      • Payments
        • Overview
        • Pay by card
        • Pay by card: complete 3DS
        • Pay with Apple Pay
        • Pay with Google Pay
        • Pay by recurring profile
        • Create payment page
        • Create payment page with any amount
        • Capture payment (clearing)
        • Cancel payment
        • Refund payment
        • Get payment status
      • Payouts
        • Overview
        • Pay out to card
        • Pay out to IBAN
        • Get payout balance
        • Get payout status
      • Transfers
        • Overview
        • Transfer from card to card
        • Transfer from card to card: complete 3DS
        • Get exchange rates
        • Get transfer status
      • Saved cards
        • Overview
        • Save card
        • Save card: complete 3DS
        • List saved cards
        • Remove saved card
        • Pay by card token
        • Pay out to card token
        • Get payment status
    • Async API
      • Overview
      • Create
        • Create payment
      • Read
        • Get payment status
        • Get request result
      • Edit
        • Capture payment (clearing)
        • Cancel payment (reverse)
        • Refund payment
  • Merchant API
    • Overview
    • Payments
      • Overview
      • Checkout
      • Pay by saved card
        • Overview
        • Create payment
        • Confirm payment with CVC
        • Confirm payment without the client
      • Create payment
      • Create payment with a payment page template
      • Create payment in a payment frame
      • Create payment with any amount
      • Create recurring payment
      • Capture payment (clearing)
      • Cancel payment
      • Refund payment
      • Get payment status
    • Payouts
      • Overview
      • Create payout page
        POST
      • Pay out to saved card
        POST
      • Pay out to IBAN
        POST
      • Get payout status
        POST
      • Get payout balance
        POST
    • Mobile balance
      • Overview
      • Init
      • Pay
      • Approve
      • Resend code
      • Status
    • Invoice
      • Overview
      • Recurring profile
        • Overview
        • Create
        • Cancel
        • Info
        • Notify
      • Tips
        • Overview
        • Create
      • Create
      • Execute
      • Info
      • Refund
      • Status
      • Cancel
    • SDK
      • JS SDK
      • Merchant SDK
        • Google Pay
        • Android
        • IOS
    • 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
    • Installment
      • Overview
      • Status
        • Application Status
        • Application Callback Status
        • Application Change Status
      • Get partners
      • Create application
    • Saved cards
      • Get saved cards
      • Save card
      • Save card for payouts
      • Delete saved card
      • Save card without a charge
    • Redirect back
      POST
    • Result notify
      POST
    • Payout notify
      POST
    • Check request
      POST
  • Partner API
    • Rates
      • Overview
      • Rates
    • Products
      • Overview
      • Dictionaries
      • Add client with product
      • Client request status
      • Create terminal
      • Update terminal limits
      • Product request status
    • E-Money
      • Overview
      • Add
      • Owner identification
      • Info
      • Close
      • Block
      • Balance
      • Statement
      • Request Status
    • Device ID
      • Android SDK
      • iOS SDK
    • Implement SuperApp
      • Overview
      • Pay
      • Refund
      • Status
    • Account
      • Overview
      • Create payment
      • Payment status
      • Batch statuses
      • Statement
      • Statement status
      • Balance
      • Balance status
    • Invoices
      • Info
  1. Payouts

Get payout status

KZ
https://api.freedompay.kz
KZ
https://api.freedompay.kz
POST
https://api.freedompay.kz
/api/payment_status2
Returns the status of a payout made by Create payout page, Pay out to saved card or Pay out to IBAN.
Find the payout by pg_payment_id or by pg_order_id. A declined payout has no pg_payment_id in the payout response: find it by pg_order_id.
Sign the request with the payout secret key: see Merchant API Overview.
In JSON, pass pg_payment_id as a number: a string returns 9999.

Request flow#

Result#

pg_statusMeaningNext step
okThe payout is found: its status is in pg_payment_status.If pg_payment_status is new or process, request the status again later or wait for the notification to pg_post_link.
errorThe request is rejected.See «Errors» below.

Errors#

The HTTP status is always 200; error responses are not signed.
pg_error_codeWhenWhat to do
1200pg_merchant_id is not passed, or neither pg_payment_id nor pg_order_id is passed.Pass pg_merchant_id and one of pg_payment_id or pg_order_id.
11068The payout is not found: wrong ID or order ID, or the payout belongs to another merchant.Check the request.
9999pg_payment_id is passed as a string in JSON, or an internal error occurred.Pass pg_payment_id as a number; repeat the request later.

Request example#

Required fields only. pg_sig is calculated with the payout secret key test_secret_key.
Line breaks in the body are added for readability: send the body as one line.

Request

Body Params multipart/form-data

Responses

🟢200Success
application/xml
Bodyapplication/xml

Examples
<?xml version="1.0" encoding="UTF-8"?>
<response>
    <pg_merchant_id>13991</pg_merchant_id>
    <pg_payment_id>4102</pg_payment_id>
    <pg_status>ok</pg_status>
    <pg_payment_status>success</pg_payment_status>
    <pg_order_id>mp-dup-45684a</pg_order_id>
    <pg_amount>100</pg_amount>
    <pg_net_amount>75</pg_net_amount>
    <pg_currency>KZT</pg_currency>
    <pg_card_name>IVAN IVANOV</pg_card_name>
    <pg_salt>yG4WsRu3biAWzIGr</pg_salt>
    <pg_sig>444ce9646cc78dc68ad55721f9ccd477</pg_sig>
</response>
🟢200Error
Previous
Pay out to IBAN
Next
Get payout balance