Credit Mobile Wallet / Bank Account

cURL

curl --request POST \
  --url https://test.digitaltermination.com/api/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data amount=0.1 \
  --data send_amount=0.1 \
  --data sender_country=GHA \
  --data send_currency=GHS \
  --data sender_first_name=Zeepay \
  --data sender_last_name=Ghana \
  --data receiver_first_name=GODWIN \
  --data receiver_last_name=HOTTOR \
  --data service_type=Wallet \
  --data receiver_msidn=123 \
  --data receiver_country=GHA \
  --data receiver_currency=GHS \
  --data transaction_type=CR \
  --data extr_id=guid-example \
  --data mno=MTN \
  --data callback_url=https://webhook.site/3b3b3b3b-3b3b-3b3b-3b3b-3b3b3b3b3b3b

import requests

url = "https://test.digitaltermination.com/api/payouts"

payload = {
    "amount": "0.1",
    "send_amount": "0.1",
    "sender_country": "GHA",
    "send_currency": "GHS",
    "sender_first_name": "Zeepay",
    "sender_last_name": "Ghana",
    "receiver_first_name": "GODWIN",
    "receiver_last_name": "HOTTOR",
    "service_type": "Wallet",
    "receiver_msidn": "123",
    "receiver_country": "GHA",
    "receiver_currency": "GHS",
    "transaction_type": "CR",
    "extr_id": "guid-example",
    "mno": "MTN",
    "callback_url": "https://webhook.site/3b3b3b3b-3b3b-3b3b-3b3b-3b3b3b3b3b3b"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/x-www-form-urlencoded"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  body: new URLSearchParams({
    amount: '0.1',
    send_amount: '0.1',
    sender_country: 'GHA',
    send_currency: 'GHS',
    sender_first_name: 'Zeepay',
    sender_last_name: 'Ghana',
    receiver_first_name: 'GODWIN',
    receiver_last_name: 'HOTTOR',
    service_type: 'Wallet',
    receiver_msidn: '123',
    receiver_country: 'GHA',
    receiver_currency: 'GHS',
    transaction_type: 'CR',
    extr_id: 'guid-example',
    mno: 'MTN',
    callback_url: 'https://webhook.site/3b3b3b3b-3b3b-3b3b-3b3b-3b3b3b3b3b3b'
  })
};

fetch('https://test.digitaltermination.com/api/payouts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://test.digitaltermination.com/api/payouts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "amount=0.1&send_amount=0.1&sender_country=GHA&send_currency=GHS&sender_first_name=Zeepay&sender_last_name=Ghana&receiver_first_name=GODWIN&receiver_last_name=HOTTOR&service_type=Wallet&receiver_msidn=123&receiver_country=GHA&receiver_currency=GHS&transaction_type=CR&extr_id=guid-example&mno=MTN&callback_url=https%3A%2F%2Fwebhook.site%2F3b3b3b3b-3b3b-3b3b-3b3b-3b3b3b3b3b3b",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/x-www-form-urlencoded"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://test.digitaltermination.com/api/payouts"

	payload := strings.NewReader("amount=0.1&send_amount=0.1&sender_country=GHA&send_currency=GHS&sender_first_name=Zeepay&sender_last_name=Ghana&receiver_first_name=GODWIN&receiver_last_name=HOTTOR&service_type=Wallet&receiver_msidn=123&receiver_country=GHA&receiver_currency=GHS&transaction_type=CR&extr_id=guid-example&mno=MTN&callback_url=https%3A%2F%2Fwebhook.site%2F3b3b3b3b-3b3b-3b3b-3b3b-3b3b3b3b3b3b")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://test.digitaltermination.com/api/payouts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/x-www-form-urlencoded")
  .body("amount=0.1&send_amount=0.1&sender_country=GHA&send_currency=GHS&sender_first_name=Zeepay&sender_last_name=Ghana&receiver_first_name=GODWIN&receiver_last_name=HOTTOR&service_type=Wallet&receiver_msidn=123&receiver_country=GHA&receiver_currency=GHS&transaction_type=CR&extr_id=guid-example&mno=MTN&callback_url=https%3A%2F%2Fwebhook.site%2F3b3b3b3b-3b3b-3b3b-3b3b-3b3b3b3b3b3b")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://test.digitaltermination.com/api/payouts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "amount=0.1&send_amount=0.1&sender_country=GHA&send_currency=GHS&sender_first_name=Zeepay&sender_last_name=Ghana&receiver_first_name=GODWIN&receiver_last_name=HOTTOR&service_type=Wallet&receiver_msidn=123&receiver_country=GHA&receiver_currency=GHS&transaction_type=CR&extr_id=guid-example&mno=MTN&callback_url=https%3A%2F%2Fwebhook.site%2F3b3b3b3b-3b3b-3b3b-3b3b-3b3b3b3b3b3b"

response = http.request(request)
puts response.read_body

{
  "code": 411,
  "message": "Transaction is pending response from a third party",
  "zeepay_id": 123456
}

POST

api

payouts

cURL

curl --request POST \
  --url https://test.digitaltermination.com/api/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data amount=0.1 \
  --data send_amount=0.1 \
  --data sender_country=GHA \
  --data send_currency=GHS \
  --data sender_first_name=Zeepay \
  --data sender_last_name=Ghana \
  --data receiver_first_name=GODWIN \
  --data receiver_last_name=HOTTOR \
  --data service_type=Wallet \
  --data receiver_msidn=123 \
  --data receiver_country=GHA \
  --data receiver_currency=GHS \
  --data transaction_type=CR \
  --data extr_id=guid-example \
  --data mno=MTN \
  --data callback_url=https://webhook.site/3b3b3b3b-3b3b-3b3b-3b3b-3b3b3b3b3b3b

import requests

url = "https://test.digitaltermination.com/api/payouts"

payload = {
    "amount": "0.1",
    "send_amount": "0.1",
    "sender_country": "GHA",
    "send_currency": "GHS",
    "sender_first_name": "Zeepay",
    "sender_last_name": "Ghana",
    "receiver_first_name": "GODWIN",
    "receiver_last_name": "HOTTOR",
    "service_type": "Wallet",
    "receiver_msidn": "123",
    "receiver_country": "GHA",
    "receiver_currency": "GHS",
    "transaction_type": "CR",
    "extr_id": "guid-example",
    "mno": "MTN",
    "callback_url": "https://webhook.site/3b3b3b3b-3b3b-3b3b-3b3b-3b3b3b3b3b3b"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/x-www-form-urlencoded"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  body: new URLSearchParams({
    amount: '0.1',
    send_amount: '0.1',
    sender_country: 'GHA',
    send_currency: 'GHS',
    sender_first_name: 'Zeepay',
    sender_last_name: 'Ghana',
    receiver_first_name: 'GODWIN',
    receiver_last_name: 'HOTTOR',
    service_type: 'Wallet',
    receiver_msidn: '123',
    receiver_country: 'GHA',
    receiver_currency: 'GHS',
    transaction_type: 'CR',
    extr_id: 'guid-example',
    mno: 'MTN',
    callback_url: 'https://webhook.site/3b3b3b3b-3b3b-3b3b-3b3b-3b3b3b3b3b3b'
  })
};

fetch('https://test.digitaltermination.com/api/payouts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://test.digitaltermination.com/api/payouts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "amount=0.1&send_amount=0.1&sender_country=GHA&send_currency=GHS&sender_first_name=Zeepay&sender_last_name=Ghana&receiver_first_name=GODWIN&receiver_last_name=HOTTOR&service_type=Wallet&receiver_msidn=123&receiver_country=GHA&receiver_currency=GHS&transaction_type=CR&extr_id=guid-example&mno=MTN&callback_url=https%3A%2F%2Fwebhook.site%2F3b3b3b3b-3b3b-3b3b-3b3b-3b3b3b3b3b3b",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/x-www-form-urlencoded"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://test.digitaltermination.com/api/payouts"

	payload := strings.NewReader("amount=0.1&send_amount=0.1&sender_country=GHA&send_currency=GHS&sender_first_name=Zeepay&sender_last_name=Ghana&receiver_first_name=GODWIN&receiver_last_name=HOTTOR&service_type=Wallet&receiver_msidn=123&receiver_country=GHA&receiver_currency=GHS&transaction_type=CR&extr_id=guid-example&mno=MTN&callback_url=https%3A%2F%2Fwebhook.site%2F3b3b3b3b-3b3b-3b3b-3b3b-3b3b3b3b3b3b")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://test.digitaltermination.com/api/payouts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/x-www-form-urlencoded")
  .body("amount=0.1&send_amount=0.1&sender_country=GHA&send_currency=GHS&sender_first_name=Zeepay&sender_last_name=Ghana&receiver_first_name=GODWIN&receiver_last_name=HOTTOR&service_type=Wallet&receiver_msidn=123&receiver_country=GHA&receiver_currency=GHS&transaction_type=CR&extr_id=guid-example&mno=MTN&callback_url=https%3A%2F%2Fwebhook.site%2F3b3b3b3b-3b3b-3b3b-3b3b-3b3b3b3b3b3b")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://test.digitaltermination.com/api/payouts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "amount=0.1&send_amount=0.1&sender_country=GHA&send_currency=GHS&sender_first_name=Zeepay&sender_last_name=Ghana&receiver_first_name=GODWIN&receiver_last_name=HOTTOR&service_type=Wallet&receiver_msidn=123&receiver_country=GHA&receiver_currency=GHS&transaction_type=CR&extr_id=guid-example&mno=MTN&callback_url=https%3A%2F%2Fwebhook.site%2F3b3b3b3b-3b3b-3b3b-3b3b-3b3b3b3b3b3b"

response = http.request(request)
puts response.read_body

{
  "code": 411,
  "message": "Transaction is pending response from a third party",
  "zeepay_id": 123456
}

For Credit Mobile Wallet Transactions, use service_type as "Wallet".
For Bank Account Transactions, use service_type as "Bank" for standard bank transfers.
For Cash Pick-up Transactions, use service_type as "Pickup" for cash pick-up services.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/x-www-form-urlencoded

📱 Mobile Wallet
🏦 Bank Account
💰 Cash PickUp

amount

integer

required

The amount to credit the mobile wallet

Example:

0.1

send_amount

integer

required

The amount to send

Example:

0.1

sender_country

string

required

The country code of the sender

Example:

"GHA"

send_currency

string

required

The currency code of the sender

Example:

"GHS"

sender_first_name

string

required

The first name of the sender

Example:

"Zeepay"

sender_last_name

string

required

The last name of the sender

Example:

"Ghana"

receiver_first_name

string

required

The first name of the receiver

Example:

"GODWIN"

receiver_last_name

string

required

The last name of the receiver

Example:

"HOTTOR"

service_type

string

required

The service type

Example:

"Wallet"

receiver_msidn

integer

required

The receiver mobile number

receiver_country

string

required

The country code of the receiver

Example:

"GHA"

receiver_currency

string

required

The currency code of the receiver

Example:

"GHS"

transaction_type

string

required

The transaction type

Example:

"CR"

extr_id

string

required

The external ID

Example:

"guid-example"

mno

string

required

The mobile service provider

Example:

"MTN"

callback_url

string

The callback URL (optional)

Example:

"https://webhook.site/3b3b3b3b-3b3b-3b3b-3b3b-3b3b3b3b3b3b"

Response

200 - application/json

Successfully processed the payout request

code

number

Static response code indicating the status

Example:

411

message

string

This is a response message from the third party

Example:

"Transaction is pending response from a third party"

zeepay_id

integer

The Zeepay ID of the transaction

Example:

123456

Instntmny Restful API (Remittance)

API Endpoint

Authorizations

Body

Response