Moneroo Standard is our "standard" payments flow that redirects your customer to a Moneroo-hosted payments page.
Here's how it works:
From your server, call the payment initialization endpoint with the payment details.
We'll return a link to a payment page. Redirect your customer to this link to make the payment.
Upon completion of the transaction, we'll redirect the customer back to you (to the return_url you provided) with the payment details.
Step 1: Collect payment details
First, you need to assemble payment details that will be sent to your API as a JSON object.
Here fields you need to collect:
Field Name
Type
Required
Description
amount
integer
Yes
The payment amount.
currency
string
Yes
The currency of the payment.
description
string
Yes
Description of the payment.
return_url
string
Yes
Return URL where your customer will be redirected after payment.
customer.email
string
Yes
Customer's email address.
customer.first_name
string
Yes
Customer's first name.
customer.last_name
string
Yes
Customer's last name.
customer.phone
string
NoΒΉ
Customer's phone number.
customer.address
string
NoΒΉ
Customer's address.
customer.city
string
NoΒΉ
Customer's city.
customer.state
string
NoΒΉ
Customer's state.
customer.country
string
NoΒΉ
Customer's country.
customer.zip
string
NoΒΉ
Customer's zip code.
metadata
array
NoΒ²
Additional data for the payment.
methods
array
NoΒ³
Payment method you want to make available for this transaction.
restrict_country_code
string
Noβ΄
Restrict the payment to a specific country.
restricted_phone
object
Noβ΄
Restrict the payment to a specific phone number.
restricted_phone.number
string
Yesβ΅
The phone number to restrict the payment to.
restricted_phone.country_code
string
Yesβ΅
The country code of the restricted phone number.
If not provided, the customer can be prompted to enter these details during the payment process based on the selected payment method.
There should be an array of key-value pairs. Only string values are allowed.
If not provided, all available payment methods will be allowed. The array should contain only the supported payment method's shortcodes.
You can use either restrict_country_code or restricted_phone, but not both. They are mutually exclusive.
Required if restricted_phone is provided.
Step 2: Obtain a Payment Link
Next, initiate the payment by calling the API with the collected payment details using the secret key for authorization.
Example request :
POST/v1/payments/initializeHost:https://api.moneroo.ioAuthorization:BearerYOUR_SECRET_KEYContent-Type:application/jsonAccept:application/json{"amount":100,"currency":"USD","description":"Payment for order #123","customer":{"email":"john@example.com","first_name":"John","last_name":"Doe" },"return_url":"https://example.com/payments/thank-you""metadata":{"order_id":"123","customer_id":"123" },"methods": ["mtn_bj", "moov_bj"]# Once again, it is not required}
You only need to redirect your customer to the link returned in data.checkout_url. We will display our payment interface for the customer to make the payment.
Step 4: After Payment
Once the payment is made, whether successful or failed, four things will occur:
We redirect your user to your return_url with the status, paymentId, and paymentStatus in the query parameters once the payment is completed.
We will send you a webhook if you have activated it. For more information on webhooks and to see examples, check out our webhooks guide.
If the payment is successful, we will send an acknowledgment email to your customer (unless you have disabled this feature).
We will email you (unless you have disabled this feature).
If you have webhooks enabled, we'll send you a notification for each failed payment attempt. This is useful in case you want to later reach out to customers who had issues paying. See our webhooks guide for an example.
Example
Do not forget to replace YOUR_SECRET_KEY with your actual secret key.
All subsequent examples should be executed in the backend. Never expose your secret key to the public.
import requestsimport jsonurl ='https://api.moneroo.io/v1/payments/initialize'headers ={'Content-Type':'application/json','Authorization':'Bearer YOUR_SECRET_KEY''Accept':'application/json'}data ={"amount":100,"currency":"USD","description":"Payment for order #123","customer":{"email":"john@example.com","first_name":"John","last_name":"Doe"},"return_url":"https://example.com/payments/thank-you","metadata":{"order_id":"123","customer_id":"123",},"methods": ["qr_ngn","bank_transfer_ngn"]}response = requests.post(url, headers=headers, data=json.dumps(data))if response.status_code !=201:raiseException(f"Request failed with status {response.status_code}")checkout_url = response.json()['checkout_url']print(f"Redirect to: {checkout_url}")
packagemainimport ("bytes""encoding/json""net/http""fmt")funcmain() { data :=map[string]interface{}{"amount": 100,"currency": "USD","description": "Payment for order #123","customer": map[string]string{"email": "john@example.com","first_name": "John","last_name": "Doe", },"return_url": "https://example.com/payments/thank-you","metadata": map[string]string{"order_id": "123","customer_id": "123", },"methods": []string{"qr_ngn", "bank_transfer_ngn"}, } bytesRepresentation, _ := json.Marshal(data) req, _ := http.NewRequest("POST", "https://api.moneroo.io/v1/payments/initialize", bytes.NewBuffer(bytesRepresentation))
req.Header.Set("Content-Type", "application/json") req.Header.Set("Authorization", "Bearer YOUR_SECRET_KEY") req.Header.Set("Accept", "application/json") client :=&http.Client{} response, _ := client.Do(req)defer response.Body.Close()var result map[string]interface{} json.NewDecoder(response.Body).Decode(&result)if response.StatusCode !=201 {panic(fmt.Sprintf("Request failed with status %d", response.StatusCode)) } fmt.Printf("Redirect to: %s", result["checkout_url"])}
constaxios=require('axios');constdata= {"amount":100,"currency":"USD","description":"Payment for order #123","customer": {"email":"john@example.com","first_name":"John","last_name":"Doe" },"return_url":"https://example.com/payments/thank-you","metadata": {"order_id":"123","customer_id":"123", },"methods": ["qr_ngn","bank_transfer_ngn"]};constoptions= { headers: {'Content-Type':'application/json','Authorization':'Bearer YOUR_SECRET_KEY''Accept': 'application/json' }};axios.post('https://api.moneroo.io/v1/payments/initialize', data, options).then((response) => {if (response.status !==201) {thrownewError(`Request failed with status ${response.status}`); }console.log(`Redirect to: ${response.data.checkout_url}`); }).catch((error) => {console.error(error); });