Cash Pickup

Description: Endpoint for cash pickup

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
reference	string	Reference number	Yes
secretQuestion	string	Secret question to be used	Yes
secretAnswer	string	Answer to the secret question	Yes
bankCode	string	Bank Code	Yes
endPoint	string	Endpoint to call. FX for foreign exchange transaction.	Yes
currency	string	Currency code. e.g USD, NGN	Yes
amount	decimal	Transaction amount	Yes
description	string	Transaction description	Yes
source	string	Source account number	No
destinationCountry	string	Country code for the destination country e.g NG	Yes
receiveAmount	decimal	Amount received	Yes
exchangeRate	decimal	Exchange rate	Yes
action	string	Action to be performed e.g. CP. 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
firstName	string	First name of the beneficiary	Yes
lastName	string	Last name of the beneficiary	Yes
email	string	Email of the beneficiary	Yes
phoneNumber	string	Phone number of the beneficiary	Yes
serial	string	ID number of the beneficiary’s means of identification	Yes
idType	string	Beneficiary’s means of identification	Yes
idIssueDate	datetime	ID date of issuance	Yes
idExpiryDate	datetime	ID expiration date	Yes
countryOfResidence	string	Country code of the beneficiary e.g NG	Yes
nationality	string	Beneficiary’s nationality	Yes
sender	object	Sender object. This is applicable when action is CP= cash pickup	No
firstName	string	First name of the sender	Yes
lastName	string	Last name of the sender	Yes
email	string	Email of the sender	Yes
phoneNumber	string	Phone number of the sender	Yes
countryOfResidence	string	Country code of the beneficiary e.g NG	Yes
nationality	string	Beneficiary’s nationality	Yes

Response Parameters

Response Parameters

Parameter	Type	Description	Mandatory
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. RT. 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}/users/cashpickup

curl `${base_url}/users/cashpickup`
-H "Content-type: application/json"
-X POST
-d '{
    "id":"2233",
    "terminalId":"7000000004",
    "terminalCard":false,
    "direction":"request",
    "transaction":{
        "pin":" kghxqwveJ3eSQJip/cmaMQ==",
        "reference":"reference{{random_number}}",
        "secretQuestion":"which animal",
        "secretAnswer":"cat",
        "endPoint":"FX",
        "bankCode":"050",
        "amount": 100,
        "exchangeRate": "105.7",
        "receiveAmount": "211",
        "destinationCountry":"KE",
        "source":"",
        "currency":"USD",
        "description":"professional travel expense"
    },
    "action":"CP",
    "account": null,
    "beneficiary": {
        "firstName": "Ugo",
        "lastName": "Omeje",
        "email": "test@test.com",
        "phoneNumber": "18003564892",
        "serial": "12234567",
        "idType": "passport",
        "idIssueDate": "",
        "idExpiryDate": "2020-08-23 00:00:00",
        "countryOfResidence": "KE",
        "nationality": "Kenya"
    },
    "sender": {
        "firstName": "Ugo",
        "lastName": "Doe",
        "phoneNumber":"18003564892",
        "email": "johndoe@tester.com",
        "countryOfResidence": "US",
        "nationality":"United State of America"
    }
}
'

Sample Response

POST {base_url}/users/cashpickup

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