Use the submitCashpickupTransaction endpoint to make an international transaction and get a transaction PIN. Send this PIN to the beneficiary, who then shares it with the bank in Nigeria. Provide a call-back URL that can be used to notify you of any change in the transaction status timely.
Syntax
POST https://nairagrambasket.com/api/submitCashpickupTransaction
Response Codes
The following table lists the status codes that are returned in response to the submitCashpickupTransaction request.
Code | Status |
---|---|
200 | Success Note: You will receive the error code 200 when the beneficiary picks up the cash. |
201 | Success pending payout to beneficiation (Do not try again) |
400 | Invalid Request |
401 | Unauthorized error: “Invalid Token” |
403 | Forbidden “You are not allowed to use this service” |
440 | Failed – Invalid bank account number” Note: Before re-initiating, editing, or canceling any transaction with the error “440, please do Get Transaction Status to confirm the updated status.” |
The beneficiary’s valid phone number is needed because the beneficiary will receive a One True Pairing Code via SMS while at the bank to cash the money. An invalid number may affect the ability to cash the funds.
Please ensure that the beneficiary’s first, middle, and last name agrees to the beneficiary’s Government-issued ID.
The Cash Pick up locations may not be the same banks included in the Bank List API.
Input Parameters
The following table lists the parameters that you need to provide in the submitCashpickupTransaction request.
Field | Value Format | Required/Optional | Description |
---|---|---|---|
username | MAIL@MAIL.l.com | Required | Input the valid email address that you submitted to your Partner Company. |
password | Your Password | Required | Input your secure password. |
secretKey | YourKey | Required | Input the API key provided to you by your Partner Company. |
senderfirstname | firstName | Required | Input the first name of the sender. For example, Jane. |
senderlastname | LastName | Required | Input the last name of the sender. For example, Doe. |
sendercity | London | Required | Input the name of the sender’s city. |
sendercountry | US | Required | Input the code for the sender’s country in ISO ALPHA-2 format. For example, US, GB, CA. |
senderaddress | No 5, Address street | Required | Input the valid address of the sender. |
senderpostalcode | 178980 | Required | Input the sender’s postal code. |
senderemail | sendermail@mail.com | Required | Input the email address of the sender. |
toaddress | Lagos | Optional | Input the valid address of the beneficiary. |
security_question_id | 2 | Required | Input the security question ID. |
security_answer | test | Required | Input the answer to the security question. |
source_of_funds | salary | Required | This can also include pensions and savings. |
purpose_of_funds | family support | Required | This can also include medication, housing, etc. |
tophone | 12345678 | Required | The beneficiary phone number is significant as this is used to deliver the OTP code to receive payments at the bank. Please Remove the country code and the leading zero from the number. |
tofirstname | Beneficiary First Name | Required | Please ensure the beneficiary’s first, middle, and last name agrees to the beneficiary’s Government-issued ID. |
tomiddlename | Beneficiary Middle Name | Optional | Please ensure the beneficiary’s first, middle, and last name agrees to the beneficiary’s Government-issued ID. |
tolastname | Beneficiary Last Name | Required | Please ensure the beneficiary’s first, middle, and last name agrees to the beneficiary’s Government-issued ID. |
dateofbirth | 1985-12-29 | Required | Input the date of birth of the sender in the valid format: YYYY-MM-DD. |
fromamount | 200 | Required | Input an amount to send. The minimum value is USD 10. |
fromcurrency | USD | Required | It can also be a settlement currency per your agreement. For example, USD, GBP, CAD, EUR. |
transaction_number | 022111712000060271266 | Required | This is your internal reference that could be used to query the transaction. It must have a minimum of 10 digits and a maximum of 25 digits. |
sendfromstate | 1 | Required | Input a 2-letter abbreviation of the sender’s state. For example, TX, NY, WA. Non-US default: 01. |
fees | 0 | Optional | Input the fees. The default fee is 0 unless specified. |
exchangerate | 1.3 | Optional | Input the exchange rate. |
toemail | a@gmail.com | Required | This is used to confirm the pickup and delivery. |
tocurrency | USD | Optional | Input the currency for the beneficiary. |
senderphone | 7654533231 | Required | Input the valid phone number of the sender. When unavailable, use the default phone number: 11111111111. |
tocountry | NG | Optional | Input the country code in ISO ALPHA-2 format. For example, NG, GH, KE. It is required for Nigeria only. |
cashpickuplocation | 002 | Required | Please call the API GetUSD Cash pick-up location for the correct code. Indicates the cash pickup location. For example, 002- Fidelity Bank or 001- Zenith Bank |
Sample Request
curl --location --request POST 'https://nairagrambasket.com/api/submitCashpickupTransaction' \
--form 'username="ankur.garg1311@gmail.com"' \
--form 'password="@Password12"' \
--form 'secretKey="XkxTvJ3banMiCT3Kzgg3"' \
--form 'senderfirstname="firstName"' \
--form 'senderlastname="LastName"' \
--form 'sendercity="London"' \
--form 'sendercountry="US"' \
--form 'senderaddress="No 5, Address street"' \
--form 'senderpostalcode="178980"' \
--form 'senderemail="sendermail@mail.com"' \
--form 'toaddress="Lagos"' \
--form 'security_question_id="2"' \
--form 'security_answer="test"' \
--form 'source_of_funds="salary"' \
--form 'purpose_of_funds="family support"' \
--form 'tophone="12345678"' \
--form 'tofirstname="Benificiary FIrst Name"' \
--form 'tomiddlename="Beneficiary Middle Name"' \
--form 'tolastname="Beneficiary Last Name"' \
--form 'dateofbirth="1985-12-29"' \
--form 'fromamount="200"' \
--form 'fromcurrency="USD"' \
--form 'transaction_number="022111712000060271266"' \
--form 'sendfromstate="1"' \
--form 'fees="0"' \
--form 'exchangerate="1.3"' \
--form 'toemail="a@gmail.com"' \
--form 'tocurrency="USD"' \
--form 'senderphone="7654533231"' \
--form 'tocountry="NG"' \
--form 'settlement_currency="USD"'
Sample Response
{
"Code": "201",
"Message": "Success without payout, do not initiate this transaction again",
"Content": {
"transaction_pin": "NGN9040150837USD"
}
}