1Voucher - Payout

When performing a payout, the customer initiates a payout and then receives a PIN-code for the voucher. They can use the voucher in any place where 1Voucher is accepted—both online and in supermarkets.


Countries and regions	South Africa
Payment currencies	ZAR
Payment amount limits	Contact your key account manager at Monetix 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 Monetix for details.
Currency conversion	On the Monetix side
Refund
Onboarding and access fee	Contact your key account manager at Monetix 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 1Voucher payment method:

Send a request with all the required parameters and signature to the Monetix URL.
Accept the callback with the payout result from the payment platform and the voucher PIN-code that you need to display to the customer.

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

Figure 1. Payout processing flow when performing a payout by using Gate

The customer initiates a payout in your system.
Your system sends the payout request to the Monetix payment platform.
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 structure.)
The payment platform processes the request and forwards it to the provider service.
The provider service informs the payment platform about the payout result and sends voucher PIN-code for payout.
The payment platform sends a callback with the payout result and voucher PIN-code to your system.
Your system sends the payout result and displays voucher PIN-code to the customer.

Request

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


HTTP request method	POST
Request body format	JSON
API endpoint	`/v2/payment/voucher/1voucher/payout`
Full API endpoint specification	/v2/payment/voucher/{payment_method}/payout

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

Object Parameter Description

general
object
strictly required

project_id
integer
strictly required

Project ID you obtained from Monetix 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

payment
object
strictly required

currency
string
strictly required

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

Example: ZAR

amount
integer
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 codes.

Example: 100.00 ZAR must be sent as 10000

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 1Voucher 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"
    },
    "payment": {
        "currency": "ZAR",
        "amount": 10000
    }
}

Callback

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

In this method, the callback additionally contains the provider_extra_fields object, which contains: amount_remnant parameter with voucher balance and pin parameter with voucher PIN code. This data must be then used by the customer to receive the payout in any place where 1Voucher is accepted—both online and in supermarkets.

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

Figure 3. 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": "1voucher",
		"sum": {
			"amount": 10000,
			"currency": "ZAR"
		},
		"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": "ZAR"
		},
		"sum_converted": {
			"amount": 10000,
			"currency": "ZAR"
		},
		"code": "0",
		"message": "Success",
		"provider": {
			"id": 12345,
			"payment_id": "123abc123-123",
			"auth_code": ""
		}
	},
	"provider_extra_fields": {
		"amount_remnant": 2000,
		"pin": "1234567812345678" 
	},
	"signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

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

Figure 4. 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": "1voucher",
		"sum": {
			"amount": 10000,
			"currency": "ZAR"
		},
		"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": "ZAR"
		},
		"sum_converted": {
			"amount": 10000,
			"currency": "ZAR"
		},
		"code": "20000",
		"message": "General decline",
		"provider": {
			"id": 12345,
			"payment_id": "123abc123-123",
			"auth_code": ""
		}
	},
	"signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Payout by using Dashboard

To make a payout through Dashboard, the merchant sends a request and receives a notification with the request processing result. There are two ways to initiate payouts through Dashboard:

single payout—you specify the currency and amount for a payout available for this method and fill in all the fields required for the selected payment method on the Dashboard pages.
as a part of a mass payment—all the parameters are specified in a CSV file. Refer to the Payouts by using Gate section for the parameters required by your payment method.

Information about completed payouts is available for viewing in the Payments and Manual Payments sections of Dashboard.

For more information about payout processing by using Dashboard, see Performing payouts.