Post Reservation
Method to process payment from end user; request attributes used to determine duration of timed payment, whether fees should be applied to recoup delivery cost and sharing on successful receipt if applicable.
Customer account is debitted for order amount passed via payment options supported. Basic redirect from client to payment widget to process payment.
End user is issued a delivery code after payment to confirm successful receipt of goods.
Payment active for defined delivery duration cited in request pending provision of delivery code. In the event it is not provided or reservation expires payment automatically reversed back to debit source.
Reservation without splits held indefinitely in vault pending when courier manually disburses it.
Recoup delivery cost for failed deliveries via setting refund delivery to true with the value of the delivery fee or add returns to match merchant return policy duration for purchased goods
Definition
https://staging.cashvaultng.com/v1.0/reservation/
Parameters
Body Params
| CustomerLink: |
string
Auto validate mobile number so user doesn't have to input it on payment page |
|
DeliveryDuration:
required
|
integer
Estimated duration to deliver goods to consumer in hours format |
| Deliverycycles: |
integer
Number of deliveries required to complete fulfillment on order |
|
DeliveryFee:
required
|
integer
Value of delivery fee is deducted by a flat fee of 500 so advised to mark up by 500; delivery fee of 3000 should be passed as 3500 |
| Returns: |
integer
How long you want funds to still reside within vault upon successful reciept confirmation in hours format. |
|
DispatchLogo:
required
|
string
Brand logo of courier to display on payment pages |
|
DispatchEmail:
required
|
string
Contact details of Dispatch |
| DispatchMobile: |
string
Contact details of Dispatch |
| DispatchName: |
string
Name of Dispatch personnel or courier supporting delivery |
|
OrderAmount:
required
|
decimal
Magnitude of order value payment should be processed for |
| OrderNumber: |
string
Order number generated from vendor billing system for order to be delivered |
|
RefundDelivery:
required
|
integer
Set to true "1" or False "0" |
|
ReservationDate:
required
|
datetime
Date of reservation |
|
ReservationId:
required
|
string
Unique identifier for courier transactions; prefixed by merchant Id e.g A00125.... |
| ReservationRequestSplits: |
array of mixedAccountNo,CBNCode,SplitPercentage
Account details of recipeints funds should be shared across |
| AccountNo: |
string
NUBIAN account number should not exceed 10 characters |
| CBNCode: |
string
List of bank codes provided in misc |
| SplitPercentage: |
decimal
Percentage of reservation amount that should be settled to entity provided in split; for increased accuracy add more decimals to a max of 5 |
| ReturnUrl: |
string
Callback url user should be redirected to after payment is successfully processed for reservation |
Headers
|
ClientID:
required
|
string
Authentication Parameter |
|
ClientSecretKey:
required
|
string
Authentication Parameter |
Examples
Secure Request Hold Request
{
"DeliveryDuration":7,
"DeliveryFee":0,
"Deliverycycles":2,
"DispatchLogo":"https://demo.com/img/dispatch.png",
"DispatchEmail":"abc@yahoo.com",
"DispatchMobile":"08037954000",
"DispatchName":"SONS",
"OrderAmount":20500,
"OrderNumber":"A0897",
"RefundDelivery":0,
"ReservationDate":"2016-03-11 19:25:05",
"ReservationId":"A0200B010",
"ReservationRequestSplits":
[
{
"AccountNo":"0123456789",
"CbnCode":"011",
"SplitPercentage":2.50
},
{
"AccountNo":"2001456941",
"CbnCode":"223",
"SplitPercentage":97.50
}
],
"ReturnUrl":"https://mangafox.me/directory/"
}
{
"DeliveryDuration":7,
"DeliveryFee":0,
"Deliverycycles":2,
"DispatchLogo":"https://demo.com/img/dispatch.png",
"DispatchEmail":"abc@yahoo.com",
"DispatchMobile":"08037954000",
"DispatchName":"SONS",
"OrderAmount":20500,
"OrderNumber":"A0897",
"RefundDelivery":0,
"ReservationDate":"2016-03-11 19:25:05",
"ReservationId":"A0200B010",
"ReturnUrl":"https://mangafox.me/directory/"
}
Result Format
200 Success
{
"ResponseCode": "00",
"ReservationId": "A0200B010",
"PaymentUrl": "https://staging.cashvaultng.com/v1.0/pay/?rid=A0200B010&returnUrl=https%3A%2F%2Fmangafox.me%2Fdirectory%2F"
}