Endpoints
Transfer

Initiate Transfer

6min

Send money to your customers/recipients in Ghana and Nigeria

POST
Request
Header Parameters
X-Api-Key
required
String
Your API Key
X-Api-User
required
String
Username for your Moolre Account
Content-Type
required
String
Set value to: "application/json"
Body Parameters
type
required
Integer
Specify the function/action type you want to perform. "2" - Initiate a transfer
channel
required
Integer
The network/channel to be used for the transfer "2" - Bank Transfer "13" - GhQR (Ghana Only) ??Make GhQR sublist id and handle processing on the backend
currency
required
String
The currency of your transfer "GHS" - Ghana Cedis "NGN" - Nigeria Naira
receiver
required
String
Phone number/Bank Account number of the recipient
accountnumber
required
String
Account number of the wallet from which to transfer
amount
required
Number
Amount to be transfered
externalref
required
String
Unique Identified you provide. You can use this ID later to check transaction status.
sublistid
optional
String
Identification code for the receiving institution. This is used for Bank Transfers Only.
reference
optional
String
Narration/Description of the Transaction


Never assume a transfer has failed unless the transfer response or status check response txstatus indicate failure.

Validate Account and Name

We recommend using the Validate Account and Name API to show the customer the name of the recipient before initiating the transfer.

List Banks

sublist is only required for "channel": 2 which represents transfer to Bank. Use the Banks List API to get the list of Banks and their code = sublistid

Transfers to other networks like MTN and Vodafone may show up as Bank Transfers depending on how we route them.



Sample Request

JSON


Sample Error Response

JSON



Response Parameters

Parameters

Description

Data Type

status

Status of the api request

  • 1 - Success
  • 0 - Failure

Int

code

Unique Identifier for the different possible responses

String

message

Endpoint response message

String/Array

go

Not applicable to this endpoint

null

data

An object that contains below parameters/String that shows where an error may be in your request

Object/String

txstatus

Status of your transfer

  • 1 - Success
  • 0 - Pending
  • 2 - Failed

Int

receiver

Recipient of the transfer

String

transactionid

Moolre generated transaction ID

String

externalref

This is the externalrefyou provided

String

thirdpartyref

Transaction ID generated by the transfer network

String

receivername

Name of the recipient

String

amount

Amount transfered

String

amountfee

Amount transferred + all fees

String

networkfee

Fee charged by the network

String

fee

Fee charged by moolre

String