Bank transfers in Africa - Scenario 1. Purchase with customer redirection

When performing a purchase, the customer is redirected to the provider service where they make a purchase.


Countries and regions	Nigeria, South Africa
Payment currencies	NGN, 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.
Special considerations Ask your key account maganer at Monetix if refunds are available for you. Minimum refund amount is 100.00 NGN. Refunds for payments in other currencies temporally unavailable. The payment details must be used for purchase only once. The customer has to initiate a new purchase for performing future payments. The payment expiration time and date are shown to the customer. If the customer fails to complete the payment before the expiration time, the payment will be declined.

Operations support


	Interfaces
	Payment Page	Gate	Dashboard
Purchase
Refund

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.

Purchase by using Payment Page

General information

To perform a purchase by using Payment Page with the Bank transfers in Africa payment method:

Send a request with all the required parameters and signature to the Monetix URL.
Accept the callback with the purchase result from the payment platform.

The following figure shows the complete purchase processing flow in the Bank transfers in Africa payment method.

Figure 1. Purchase processing steps for a purchase by using Payment Page

The customer initiates a purchase in your system.
Your system sends the request for the purchase through Payment Page to the Monetix URL.
The checkout page is displayed to the customer.
The customer chooses to make a purchase with the Bank transfers in Africa payment method.
The payment platform processes the request and forwards it to the provider service.
The provider service sends the customer redirection data to the payment platform.
The checkout page redirects the customer to the provider service.
The customer completes the purchase.
The customer is redirected back to the checkout page.
The provider service sends the purchase result information to the payment platform.
The payment platform sends a callback with the payment result to your system.
The payment platform displays the payment result to the customer on the checkout page.

Request

The following table lists the parameters that you need to include in the request for purchase through the checkout page with the Bank transfers in Africa payment method.

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

required—the parameter is required for purchase processing but using it in the initial request is optional. If you don't specify this parameter in your request, the checkout page will contain an additional field for the customer to enter the missing information. For more information on how to act in such cases, see Submission of additional payment information.

optional—the parameter is optional but adding it to the request either makes the payment process more customer-friendly or helps to increase the percentage of successful payments.

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

Parameter Description

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

customer_id
string
strictly required

Unique ID of the customer within your project.

Example: customer_123

customer_first_name
string
strictly required

Customer's first name.

Example: John

customer_last_name
string
strictly required

Customer's last name.

Example: Doe

customer_email
string
strictly required

Customer's email.

Example: johndoe@example.com

customer_phone
string
required✱

Customer phone number without a plus sign (+), only digits without spaces and punctuation.

Example: 123456789

identify_doc_number
string
required✱

The number of the document establishing the identity of the customer. Required when performing a purchase in South Africa. Document number can be one of the following: passport number (1 letter and 8 digits), identification number of customer (13 digits).

Example: 1234567891012

payment_currency
string
strictly required

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

Example: NGN

payment_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 NGN must be sent as 10000

force_payment_method
string
optional

Parameter that allows you to enforce the Bank transfers in Africa payment method for your customer and skip the page with payment method selections.

To enforce the Bank transfers in Africa payment method and skip the page with payment method selection, add the force_payment_method parameter to the request and set its value to bank-transfer-africa. For more information about enforcing payment methods, see Preselecting payment methods.

Example: force_payment_method: 'bank-transfer-africa'

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.

account_type
string
required✱

Customer's account type. Possible values: cheque—for current account, savings—for savings account, transmission—for the account used for transmitting funds between financial institutions.

Possible values:

cheque—current account
savings—savings account
transmission—number of the account used for transmitting funds between financial institutions.

Example: savings

You can also add any other optional parameters to the request, if necessary. For the list of all the parameters possible in requests to Payment Page, see Payment Page invocation parameters.

Here is an example of the data from a request to open the checkout page by using EPayWidget:

EPayWidget.run(
	{
		project_id: 1234,
		payment_id: 'payment_47',
		customer_id: 'customer_123',
		customer_first_name: 'John',
		customer_last_name: 'Doe',
		customer_email: 'johndoe@example.com',
		customer_phone: '123456789',
		identify_doc_number: '1234567891012',
		payment_currency: 'NGN',
		payment_amount: 10000,
		force_payment_method: 'bank-transfer-africa',
		signature: 'kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg==',
		account_type: 'savings'
	}
)

Callback

In the Bank transfers in Africa payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Payment Page.

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

Figure 2. Example of the data from a successful purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "Bank transfer africa",
        "sum": {
            "amount": 10000,
            "currency": "NGN"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "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": "NGN"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "NGN"
        },
        "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 purchase.

Figure 3. Example of the data from a declined purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "Bank transfer africa",
        "sum": {
            "amount": 10000,
            "currency": "NGN"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "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": "NGN"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "NGN"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Purchase by using Gate

General information

To perform a purchase by using Gate with the Bank transfers in Africa payment method:

Send a request with all the required parameters and signature to the Monetix URL.
Redirect the customer to the provider service.
Accept the callback with the purchase result from the payment platform.

The following figure provides the details of the purchase processing flow in the Bank transfers in Africa payment method.

Figure 4. Purchase processing flow when performing a purchase by using Gate

The customer initiates a purchase in your system.
Your system sends the purchase 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 sends the customer redirection data to the payment platform.
The payment platform forwards the data to your system in the redirect_data object.
Your system redirects the customer to the provider service.
The customer completes the purchase.
The customer is redirected to your system.
The provider service informs the payment platform about the purchase result.
The payment platform sends the callback with the payment result to your system.
Your system sends the payment result to the customer.

Request

This section provides the instructions on how to build the request for purchase with the Bank transfers in Africa payment method.


HTTP request method	POST
Request body format	JSON
API endpoint	`/v2/payment/bank-transfer/africa/sale`
Full API endpoint specification	/v2/payment/bank-transfer/{payment_method}/sale

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

required—the parameter is required for purchase processing but using it in the initial request is optional. If you omit this parameter from the request, the payment platform will request the parameter by sending your system a callback with the list of all the missing parameters you are required to submit. For more information on how to act in such cases, see Submission of additional payment information.

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

Object 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

phone
string
required✱

Customer phone number without a plus sign (+), only digits without spaces and punctuation.

Example: 123456789

identify
object
required✱

doc_number
string
required✱

Example: 1234567891012

account
object
strictly required✱

type
string
required✱

Customer's account type.

Possible values:

cheque—current account
savings—savings account
transmission—number of the account used for transmitting funds between financial institutions.

Example: savings

bank_id
integer
strictly required✱

Customer's bank ID. For information on how to get the list of the supported banks IDs, see Banks available for purchase.

Example: 12345

security_code
string
strictly required✱

Bank Verification Number (BVN) consisting of 11 digits. Required when performing a purchase in Nigeria.

Example: 12345678910

payment
object
strictly required

currency
string
strictly required

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

Example: NGN

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.

Example: 100.00 NGN must be sent as 10000

return_url
object
strictly required

return
string
strictly required

The URL to redirect the customer to when they prematurely terminate the payment. This URL is also used if the success and decline parameters are not specified in the request. If you don't specify any parameters of the return_url object in the request, by default Gate will redirect the customer to the URL specified in your project in Monetix.

Example: https://example.com/return/

You can also add any other optional parameters to the purchase 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 purchase with the Bank transfers in Africa payment method:

Figure 5. Example of the purchase 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",
        "phone": "123456789",
        "identify": {
            "doc_number": "1234567891012"
        }
    },
    "account": {
        "type": "savings",
        "bank_id": 12345,
        "security_code": "12345678910"
    },
    "payment": {
        "currency": "NGN",
        "amount": 10000
    },
    "return_url": {
        "return": "https://example.com/return/"
    }
}

Customer redirection

After receiving and processing your purchase request, the payment platform sends you the callback with the data for redirecting the customer to the provider service.

To redirect the customer, use the values of the following parameters in the redirect_data object:

url—the URL to redirect the customer to
body—the data to send in the request body
method—the HTTP method for retrieving the website page (for example, POST or GET)
encrypted—this is the service parameter. Ignore it.

Here is an example of the callback snippet with the data to redirect the customer.

"redirect_data": {
    "method": "GET",
    "body": [],
    "encrypted": [],
    "url": "https://example.com/redirect"
}

Callback

In the Bank transfers in Africa payment method, the payment platform returns the purchase result in a callback. For the information about the callback structure, see Callbacks in Gate.

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

Figure 6. Example of the data from a successful purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "Bank transfer africa",
        "sum": {
            "amount": 10000,
            "currency": "NGN"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "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": "NGN"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "NGN"
        },
        "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 purchase.

Figure 7. Example of the data from a declined purchase callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "Bank transfer africa",
        "sum": {
            "amount": 10000,
            "currency": "NGN"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "sale",
        "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": "NGN"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "NGN"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Refund by using Gate

General information

To perform a refund by using Gate for a purchase made with the Bank transfers in Africa payment method:

Send a request with all the required parameters and signature to the Monetix URL.
Accept the callback with the refund result from the payment platform.

The following picture provides all the details of the refund processing flow in the Bank transfers in Africa payment method.

Figure 8. Refund processing flow when performing a refund by using Gate

The customer initiates a refund in your system.
Your system sends the refund 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 refund result.
The payment platform sends you the callback with the refund result.
Your system sends the refund result to the customer.

Request

This section provides the instructions on how to build the request for refund with the Bank transfers in Africa payment method.


HTTP request method	POST
Request body format	JSON
API endpoint	`/v2/payment/bank-transfer/africa/refund`
Full API endpoint specification	/v2/payment/bank-transfer/{payment_method}/refund

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

optional—the parameter is optional but adding it to the request either makes the payment process more customer-friendly or helps to increase the percentage of successful payments.

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

ID of the payment the refund is performed for

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

currency
string
optional

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

This parameter is required when performing a partial refund.

Example: NGN

amount
integer
optional

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.

This parameter is required when performing a partial refund.

Example: 100.00 NGN must be sent as 10000

description
string
strictly required

Refund description.

Example: Refund description.

You can also add any other optional parameters to the refund 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 refund with the Bank transfers in Africa payment method:

Figure 9. Example of the refund request body

{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=="
    },
    "payment": {
        "currency": "NGN",
        "amount": 10000,
        "description": "Refund description."
    }
}

Callback

In the Bank transfers in Africa payment method, the payment platform returns the refund result in a callback. For the information about the callback structure, see Callbacks in Gate.

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

Figure 10. Example of the body of a successful refund callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "refunded",
        "date": "2024-12-07T19:08:45+0000",
        "method": "Bank transfer africa",
        "sum": {
            "amount": 0,
            "currency": "NGN"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "refund",
        "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": "NGN"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "NGN"
        },
        "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 refund.

Figure 11. Example of the data from a declined refund callback

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "purchase",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "Bank transfer africa",
        "sum": {
            "amount": 10000,
            "currency": "NGN"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "refund",
        "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": "NGN"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "NGN"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Banks available for purchase

Supported banks

In the Bank transfers in Africa payment method, payments are performed through the banks the payment method supports. For the purchase to be performed, your request must contain the ID of the customer's bank in the account.bank_id parameter.

The table below lists the banks available for purchase in the Bank transfers in Africa payment method.

Table 4. Banks available for purchase (South Africa)
Bank	ID
ABSA Bank ZA	21311
African Bank ZA	74292
Bidvest Bank ZA	74322
Capitec Bank ZA	21341
First National Bank ZA	438
Investec Bank ZA	21351
Nedbank Limited ZA	2841
Standard Bank ZA	21331
Tyme Bank ZA	74422

Table 5. Banks available for purchase (Nigeria)
Bank	ID
OPAY	75502
PALMPAY	73812

The table with the list of banks is provided for informational purposes only. It may change without notice. To get the current list of banks the Bank transfers in Africa payment method supports, send a request to the payment platform.

Request for the list of available banks

This section provides the instructions on how to build the request for the list of banks supported in the Bank transfers in Africa payment method.


HTTP request method	POST
Request body format	JSON
API endpoint	`/v2/info/banks/bank-transfer/africa/sale/list`
Full API endpoint specification	/v2/info/banks/{parentMethod}/{childMethod}/{operationType}/list

strictly required—parameter is required in the initial request.

Object Parameter Description

general
object
strictly required

project_id
integer
strictly required

Project ID you obtained when integrating with Monetix.

Example: 123

payment_id
string
strictly required

Payment ID unique within the project.

If the payment is not yet created, set this parameter to a unique value.

Example: payment_47

signature
string
strictly required

Signature created after you specify all the required parameters. For more information about signature generation, see Signature generation and verification.

payment
object
strictly required

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.

Example: 100.00 NGN must be sent as 10000

currency
string
strictly required

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

Example: NGN

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

Here is an example of the data from the request for the list of banks available in the Bank transfers in Africa payment method.

Figure 12. Example of the data from the request for the list of available banks

{
    "general": {
        "project_id": 200,
        "payment_id": "ORDER_155860015",
        "signature": "K6jll2ym+PtOb3ocZtr345st...=="
    },
    "payment": {
        "amount": 10000,
        "currency": "NGN"
    }
}

Figure 13. Example of the response with the list of banks available in the payment method

[
    {
        "minAmount": 100, // Minimum payment amount allowed for the payment (in minor currency units)
        "maxAmount": 1000, // Maximum payment amount allowed for the payment (in minor currency units)
        "limitCurrency": "NGN", // Code of the currency used for the payment limits (minAmount and maxAmount) in the ISO-4217 alpha-3 format
        "id": 123, // Bank ID
        "abbr": "EXB", // Bank shortcut name (for internal use)
        "name": "Example Bank", // General bank name
        "nativeName": "Example Bank", // Native bank name
        "currencies": [ // Array with currencies supported by the bank
            {
                "id": 123, // Currency ID in the payment platform
                "alpha_3_4217": "NGN", // Alphabetic code of the payment currency in the ISO-4217 alpha-3 format
                "number_3_4217": "123", // Numeric code of the payment currency in the ISO-4217 alpha-3 format
                "currency_type": "fiat", // Type of the currency
                "exponent": 2 // Number of decimal places after decimal point
            }
        ]
    }
]

Bank transfers in Africa - Scenario 1. Purchase with customer redirection

Operations support

Purchase by using Payment Page

General information

Request

Callback

Related topics

Purchase by using Gate

General information

Request

Customer redirection

Callback

Related topics

Refund by using Gate

General information

Request

Callback

Related topics

Banks available for purchase

Supported banks

Request for the list of available banks