Opay

To enable the Opay payment method, you need to use direct integration. When creating a payment, send a request with the following parameters:

Parameter	Type	Required	Description
`pos_id`	UUID	✅	Merchant's identifier (`POS_ID`)
`mode`	MODE	✅	`direct`
`method`	METHOD	✅	Payment method (`purchase`)
`amount`	Number	✅	Transaction amount. Must be a positive number
`currency`	CURRENCY	✅	Transaction currency (ISO_4217)
`order_3ds_bypass`	String	✅	3-D Secure flow option
`order_id`	String	✅	Unique identifier of order
`description`	String	✅	Payment description
`payway`	String	✅	`wallet`
`customer_fname`	String		Customer's first name
`customer_lname`	String		Customer's last name
`customer_email`	String		Customer's email
`customer_phone`	String		Customer's phone
`customer_country`	String		Customer's country (ISO 3166-1 alpha-2)
`customer_city`	String		Customer's city
`customer_ip`	String		Customer's IP address
`properties.instrument_type`	String	✅	Instrument type (`wallet`)
`properties.instrument_method`	String	✅	Instrument method (`WALLET_OPAY`)
`server_url`	URL		Webhook notification will be sent to this URL
`result_url`	URL		Customer will be redirected to this URL after payment

info

Additional data collection on the payment system side

If one or more of the following parameters are not passed in the request, the payer will see an additional page to enter the missing data:

customer_email — customer's personal email
customer_fname — customer's first name
customer_lname — customer's last name
customer_phone — customer's phone number

Request example:

{
    "pos_id":                   "00000000-0000-0000-0000-000000000000",
    "mode":                     "direct",
    "amount":                   1,
    "method":                   "purchase",
    "currency":                 "NGN",
    "payway":                   "wallet",
    "properties": {
        "instrument_type":      "wallet",
        "instrument_method":    "WALLET_OPAY"
    },
    "order_3ds_bypass":         "supported",
    "description":              "Description",
    "order_id":                 "1234567890",
    "server_url":               "http://callback-stub:9000/consume",
    "result_url":               "https://google.com"
}