Payout

When performing a payout, the customer initiates a payout, chooses a suitable option and then waits for the funds to be credited to their account.

Countries and regions Global
Payment currencies Contact your key account manager at Flashpay for details.
Payment amount limits Contact your key account manager at Flashpay for details. Also you can check the payment amount limits in your project by using Dashboard.
Payment processing time Contact your key account manager at Flashpay for details.
Currency conversion On the Flashpay side
Refund
Onboarding and access fee Contact your key account manager at Flashpay for details.

Operations support

Interfaces
Payment Page Gate Dashboard
Payout

You can check the payment amount limits in your project by using Dashboard. To check your payment amount limits, go to Dashboard, select the Projects section, and then click the Payment methods tab.

The following sections provide more information about the payment processing flow and the analysis of completed payments.

Payout by using Gate

General information

To perform a payout by using Gate with the Voucher payment method:

  1. Send a request with all the required parameters and signature to the Flashpay URL.
  2. Accept the callback with the dispaly_data array from the payment platform. Show the screen with the payment details to the customer.
  3. Send a request to continue payout with all the required parameters and signature to the Flashpay URL.
  4. Accept the callback with the payout result from the payment platform.

The following picture provides the details of the payout processing flow in the Voucher payment method.



Figure 1. Payout processing flow when performing a payout by using Gate
  1. The customer initiates a payout in your system.
  2. Your system sends the payout request to the Flashpay payment platform.
  3. The payment platform sends you a response in which it acknowledges your request and provides the request validation result. (For more information about the response format, see Response format.)
  4. The payment platform prepares the payment options to show to the customer and sends them to your system in the display_data array.
  5. Your system displays the payment options from the display_data array to the customer.
  6. The customer chooses of the options.
  7. Your system sends the second part of the payout request to the Flashpay payment platform.
  8. The payment platform processes the request and forwards it to the provider service.
  9. The provider service informs the payment platform about the payout result.
  10. The payment platform sends a callback with the payout result to your system.
  11. Your system sends the payout result to the customer.

Request

This section provides the instructions on how to build the request for payout with the Voucher payment method.

HTTP request method POST
Request body format JSON
API endpoint /v2/payment/voucher/payout
Table 1. Basic parameters of a payout request

strictly required—the parameter must be in the initial request.

✱—the parameter may not be required in some cases. Contact your account manager at Flashpay for details.
ObjectParameterDescription

general
object
strictly required

project_id
integer
strictly required

Project ID you obtained from Flashpay when integrating.

Example: 1234

payment_id
string
strictly required

Payment ID unique within your project.

Example: payment_47

signature
string
strictly required

Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.

customer
object
strictly required

id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

ip_address
string
strictly required

IP address of the customer's device.

Example: 198.51.100.47

first_name
string
strictly required

Customer's first name.

Example: John

last_name
string
strictly required

Customer's last name.

Example: Doe

email
string
strictly required

Customer's email.

Example: johndoe@example.com

account
object
strictly required✱

number
integer
strictly required✱

Customer's account number.

Example: 123456789

payment
object
strictly required

currency
string
strictly required

Code of the payment currency in the ISO-4217 alpha-3 format.

Example: RUB

amount
string
strictly required✱

Payment amount in minor currency units without any decimal point or comma except for the cases when the currency doesn't have any minor currency units.

If the currency doesn't have any minor units (i.e. the number of digits for minor currency units is zero), set this parameter to the amount in the major currency units. To check whether the currency has any minor units, see Currency units and Currency codes.

You can specify any number, since the actual payment amount will only be known once this request has been processed.

Example: 100.00 RUB must be sent as 10000

service_code
string
strictly required✱

Service chosen by the customer. The list of available services is provided by your Flashpay key account manager.

Example: 123456

You can also add any other optional parameters to the payout request, if necessary. For the list of all the parameters available in Gate, see API Reference.

Here is an example of the data from a request to initiate a payout with the Voucher payment method:

Figure 2. Example of the payout request body
{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com"
    },
    "account": {
        "number": 123456789
    },
    "payment": {
        "currency": "RUB",
        "amount": "10000",
        "service_code": "123456"
    }
}

Displaying the payment instructions to the customer

After receiving and processing your payout request, the payment platform sends you the callback with the data for displaying the payment instructions to the customer.

Use the data from the display_data array to display the payment instructions to the customer.

Description of the display_data array, containing objects with details about the options available to the customer:

  • package_id—ID of the available option. It needs to be sent back in the payment.package_id parameter in the request to continue payout. This parameter may not be present in the callback, if the customer has only one available option.
  • title—Detailed information about the available option. This parameter may not be present in the callback, if the customer has only one available option.
  • provider_amount—Payment amount.
  • provider_currency—Payment currency.

The following is the callback fragment containing display_data array if several options are available for the customer.

"display_data": [
	{
		"package_id": "205",
		"title": "eSIM, 1GB, 7 Days, VietNam, V2, Speed: 2G,3G,4G,5G, Countries: Vietnam",
		"provider_amount": "990",
		"provider_currency": "RUB"
	}, 
	{
		"package_id": "220",
		"title": "eSIM, Unlimited, 1 Day, VietNam, V2, Speed: 2G,3G,4G,5G, Countries: Vietnam",
		"provider_amount": "1067",
		"provider_currency": "RUB"
	}, 
	{
		"package_id": "263",
		"title": "eSIM, Unlimited Essential, 1 Day, VietNam, V2, Speed: 2G,3G,4G,5G, Countries: Vietnam",
		"provider_amount": "1276",
		"provider_currency": "RUB"
	}, 
	{
		"package_id": "526",
		"title": "eSIM, Unlimited Plus, 1 Day, VietNam, V2, Speed: 2G,3G,4G,5G, Countries: Vietnam",
		"provider_amount": "2553",
		"provider_currency": "RUB"
	}	 
]

The following is the callback fragment containing display_data array if only one option is available for the customer.

"display_data": [
	{
		"provider_amount": "990",
		"provider_currency": "RUB"
	}   
]

Request to continue payout

This section provides the instructions on how to build the request to continue payout with the Voucher payment method.

HTTP request method POST
Request body format JSON
API endpoint /v2/payment/merchant_auth
Table 2. Basic parameters of a request to continue payout

strictly required—the parameter must be in the initial request.

✱—the parameter may not be required in some cases. Contact your account manager at Flashpay for details.
Object Parameter Description

general
object
strictly required

project_id
integer
strictly required

 Project ID you obtained from Flashpay when integrating.

Example: 1234

payment_id
string
strictly required

 Payment ID unique within your project. Must be the same as general.payment_id in the initial request.

Example: payment_47

signature
string
strictly required

 Signature created after you've specified all the request parameters. For more information about signature generation, see Signature generation and verification.

payment
object
strictly required✱

package_id
string
strictly required✱

 ID of the option chosen by the customer. It is sent in the display_data array in the callback after the initial payout request.

Example: 123
You can also add any other optional parameters to the payout request, if necessary. For the list of all the parameters available in Gate, see API Reference.

Here is an example of the data from a request to initiate a payout with the Voucher payment method:

Figure 3. Example of the payout request body
{
	"general": {
		"project_id": 1234,
		"payment_id": "payment_47",
		"signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=="
	},
	"payment": {
		"package_id": "123"
	}
}

Callback

In the Voucher payment method, the payment platform returns the payout result in a callback. For the information about the callback structure, see Callbacks.

The following is an example of a callback body with the information about a successfully completed payout.

Figure 4. Example of the data from a successful payout callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "payout",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "Voucher",
        "sum": {
            "amount": 10000,
            "currency": "RUB"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "payout",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "RUB"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "RUB"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

The following is an example of a callback for a declined payout.

Figure 5. Example of the data from a declined payout callback
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "payout",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "Voucher",
        "sum": {
            "amount": 10000,
            "currency": "RUB"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "payout",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "RUB"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "RUB"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Related topics

Payouts by using Dashboard

When working with Dashboard, you can process single and mass payouts by using the Voucher method.

  • To process a single payout, open the payout form, specify all required parameters (including the payment method), send a request and verify that the payout has been processed.

  • To process a mass payout, prepare and upload a file with information about all target payouts, send a batch request, and verify that the payouts have been processed.

    Use a CSV file structured according to the requirements presented in the Mass payments data section. The payout parameters must comply with the requirements (you do not have to generate a signature because it is specified by Dashboard).

More information about processing payouts by using Dashboard is presented in a separate section.