Type AV
How to make a payment with AV type connected terminal.
Before you start
How to authorize your requests
How to create regular orders
This integration is not available for all merchants. Check availability with your manager.
What's different from a regular order?
For this payment method, you add extra fields in customer. The rest of the fields (amount, currency, successUrl, failUrl, etc.) remain the same as in a regular order creation.
The customer.country field and at least one of customer.phone or
customer.email are required for this payment method.
Additional fields for a regular order
| Field | Type | Description |
|---|---|---|
customer | object | Buyer's data (email, phone, address, etc.) |
South Africa (Bank Transfer)
The paymentLink from the response redirects the buyer to the provider's page where they complete the payment.
Customer object fields
| Field | Type | Description |
|---|---|---|
country | string | Country code for the payment (ZA), required |
phone | string | Buyer's phone number, format 27XXXXXXXXX |
email | string | Buyer's email, required |
firstName | string | First name, required |
lastName | string | Last name, required |
Example request
{
"purpose": "Payment for order #1234",
"amount": "1000.5",
"externalId": "external_id",
"externalUserId": "external_user_id",
"successUrl": "https://example.com",
"failUrl": "https://example.com",
"callbackUrl": "https://example.com",
"currency": "ZAR",
"isFeeOnUser": false,
"customer": {
"lastName": "Doe",
"firstName": "John",
"country": "ZA",
"phone": "27000000000",
"email": "john.doe@example.com"
}
}Example response
{
"id": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
"status": "CREATED",
"statusMessage": "Ok",
"purpose": "Payment for order #1234",
"amount": "1000.5",
"currency": "ZAR",
"paymentType": null,
"shopId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
"terminalId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
"fingerprint": null,
"ipAddress": null,
"gatewayTransactionId": null,
"merchantId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
"externalId": "external_id",
"externalUserId": "external_user_id",
"paymentLink": "https://example.com/payment",
"successUrl": "https://example.com",
"failUrl": "https://example.com",
"metadata": null,
"callbackUrl": "https://example.com",
"payedAt": null,
"updatedAt": "2023-03-21T12:34:56Z",
"createdAt": "2023-03-21T12:34:56Z"
}Nigeria (Bank Transfer / OPay)
The paymentLink from the response opens a payment page with temporary bank account details (bank name, account number, account name). The buyer makes a manual transfer to these details from their banking app or wallet.
The account details are one-time and valid only for the exact order amount. Warn the buyer to transfer the exact amount in a single payment — otherwise processing may take much longer or the funds may be lost.
Customer object fields
| Field | Type | Description |
|---|---|---|
country | string | Country code for the payment (NG), required |
phone | string | Buyer's phone number, required for OPay |
email | string | Buyer's email, required |
firstName | string | First name |
lastName | string | Last name |
Example request
{
"purpose": "Payment for order #1234",
"amount": "10000",
"externalId": "external_id",
"externalUserId": "external_user_id",
"successUrl": "https://example.com",
"failUrl": "https://example.com",
"callbackUrl": "https://example.com",
"currency": "NGN",
"isFeeOnUser": false,
"customer": {
"lastName": "Doe",
"firstName": "John",
"country": "NG",
"phone": "2349061239999",
"email": "john.doe@example.com"
}
}Example response
{
"id": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
"status": "CREATED",
"statusMessage": "Ok",
"purpose": "Payment for order #1234",
"amount": "10000",
"currency": "NGN",
"paymentType": null,
"shopId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
"terminalId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
"fingerprint": null,
"ipAddress": null,
"gatewayTransactionId": null,
"merchantId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
"externalId": "external_id",
"externalUserId": "external_user_id",
"paymentLink": "https://example.com/payment",
"successUrl": "https://example.com",
"failUrl": "https://example.com",
"metadata": null,
"callbackUrl": "https://example.com",
"payedAt": null,
"updatedAt": "2023-03-21T12:34:56Z",
"createdAt": "2023-03-21T12:34:56Z"
}