Funds Transfer

Description: Funds transfer endpoint

Request Parameters

Request Parameters

Parameter	Type	Description	Required
id	Integer	Unique Identifier	Yes
terminalId	string	Terminal Identifier	Yes
terminalCard	boolean	Terminal Card parameter	Yes
direction	string	Parameter to identify of message is a request or response. Value “request” is to be passed for requests	Yes
transaction	object	An object holding the transaction information as follows:	Yes
pin	string	AES encrypted pin	Yes
accountType	string	Account type	No
bankCode	string	Bank Code. NUBAN Bank code should be passed here for transactions to be deposited to naira NUBAN account	Yes
currency	string	Currency code. e.g USD, NGN	Yes
destinationCurrency	string	Destination Currency code. e.g USD, NGN. This will be used to determine if transaction will be terminated in destination currency e.g. Naira account.The value here should be NGN for transactions that are expected to be deposited into Naira NUBAN account	Yes
amount	decimal	Transaction amount	Yes
description	string	Transaction description	Yes
destination	string	Destination account number. Beneficiary NUBAN naira account is to be passed here for transactions that are expected to be deposited into Naira NUBAN account	Yes
reference	string	Reference number	Yes
sourceCountry	string	Country code for the source country e.g. US	Yes
destinationCountry	string	Country code for the destination country e.g NG	Yes
transactionDate	datetime	Transaction date	No
receiveAmount	decimal	Amount received	Yes
exchangeRate	decimal	Exchange rate	Yes
transType	string	Transaction type	Yes
transactionPurpose	string	The Purpose of Transaction	Yes
senderFirstName	string	Sender’s first name	Yes
senderMiddleName	string	Sender's Middle Name	No
senderLastName	string	Sender’s last name	Yes
senderAddress	string	Sender's Address	Yes
senderCity	string	Sender's City	Yes
senderZip	string	Sender's Zip	Yes
senderState	string	Sender's State	Yes
senderPhone	string	Sender's Phone	Yes
senderOccupation	string	SenderOccupation	Yes
receiverFirstName	string	Receiver's FirstName	Yes
receiverMiddleName	string	Receiver's MiddleName	Yes
receiverLastName	string	Receiver's LastName	Yes
receiverRelationship	string	Receiver's Relationship	Yes
receiverMobile	string	Receiver's Mobile	Yes
receiverEmail	string	Receiver's Email	Yes
receiveCountryCode	string	Receiver's CountryCode	Yes
receiverCity	string	Receiver's City	Yes
receiverAddress	string	Receiver's Address	Yes
receiverOccupation	string	Receiver's Occupation	Yes
endPoint	string	Endpoint to call. FX for foreign exchange transaction. A for naira account M for pocketmoni wallet	Yes
action	string	Action to be performed e.g. FT. The transaction type to be performed. Refer to section 1.2 for possible actions.	Yes
account	string	Account object	No
beneficiary	object	Beneficiary object. This is applicable when action is CP= cash pickup	No
sender	object	Sender object. This is applicable when action is CP= cash pickup	No

Response Parameters

Response Parameters

Parameter	Type	Description	Required
direction	string	Parameter to identify of message is a request or response. Value “response” is to be returned for response	Yes
reference	string	Reference Number	Yes
companyId	string	Company Identifier	No
date	string	date	No
amount	decimal	Transaction amount	Yes
totalFailed	integer	Total number of transactions that failed	No
totalSuccess	integer	Total number of transactions that succeeded	No
error	integer	Error code. If there are no error, value here will be 0	Yes
message	string	Message received as response data	Yes
bulkItems	object	Object holding bulk items	No
otherReference	string	Other reference number	No
action	string	Action performed e.g. FT. The transaction type performed. Refer to section 1.2 for possible actions	Yes
records	string	Not used	No
currency	string	Currency Code	No
openingBalance	decimal	Opening Balance	No
closingBalance	decimal	Closing Balance	No
bankCode	string	Bank Code	No

Sample Request

Request Parameters

POST {base_url}/fund-transfer

curl `${base_url}/fund-transfer`
-H "Content-type: application/json"
-X POST
-d '{
    "id":"2233",
    "terminalId":"7000000004",
    "terminalCard":false,
    "direction":"request",
    "transaction": {
        "accountType": "",
        "bankCode":"214",
        "currency":"USD",
        "destinationCurrency":"NGN",
        "amount": 100.00,
        "description":"sending fx money",
        "destination":"2528407029",
        "reference":"reference-98840897",
        "sourceCountry":"US",
        "destinationCountry":"NG",
        "transactionDate": null,
        "receiveAmount": "211.4",
        "exchangeRate": "7.56000",
        "endPoint":"A",
        "pin":"kghxqwveJ3eSQJip/cmaMQ==",
        "transType": "mm",
        "transactionPurpose":"professional travel expense",
        "senderFirstName": "Ugochukwu",
        "senderMiddleName": "",
        "senderLastName": "Michael",
        "senderAddress":"3 John Lane, Connecticut, USA",
        "senderCity": "lagos",
        "senderZip": "1002",
        "senderState": "lagos",
        "senderPhone": "08138390589",
        "senderOccupation":"Journalist",
        "receiverFirstName": "DEBORAH",
        "receiverMiddleName": "",
        "receiverLastName": "OGOCHI",
        "receiverRelationship": "Sister",
        "receiverMobile": "08138390589",
        "receiverEmail": "ugo@mail.com",
        "receiveCountryCode": "NG",
        "receiverCity": "lagos",
        "receiverAddress": "lagos",
        "receiverOccupation": "Welder"
    },
    "action":"FT",
    "account": null,
    "beneficiary": null,
    "sender": null
}
'

Sample Response

Sample Success Response

POST {base_url}/fund-transfer

{
  "direction": "response",
  "reference": "09FG211014143106982FGW7JL",
  "companyId": null,
  "date": null,
  "amount": 0,
  "totalFailed": 0,
  "totalSuccess": 0,
  "error": "31",
  "message": "Pending Transaction upon confirmation from bank",
  "bulkItems": null,
  "otherReference": "reference53641",
  "action": "FT",
  "records": null,
  "currency": null,
  "openingBalance": 0,
  "closingBalance": 0,
  "bankCode": null
}

Sample Failure Response

POST {base_url}/fund-transfer

{
  "direction": "response",
  "reference": "09FG211014143516608XZXLG9",
  "companyId": null,
  "date": null,
  "amount": 0,
  "totalFailed": 0,
  "totalSuccess": 0,
  "error": "26",
  "message": "first name cannot be null",
  "bulkItems": null,
  "otherReference": "reference17001",
  "action": "FT",
  "records": null,
  "currency": null,
  "openingBalance": 0,
  "closingBalance": 0,
  "bankCode": null
}