Skip to main content

Submit Reservation

With this API endpoint, you can export ordersreservations to Front Payment Go and get paymentcheckout URLs in return. 

Endpoint : https://demo-api.frontpayment.no/api/v1/connect/orders/regular/reservations/submit
Method : POST
Authorization : Bearer
Payload Validations : 
'products.*.name'customerDetails' => 'required|string',
'products.*.productId' => 'nullable|string',
'products.*.quantity' => 'required|numeric',
'products.*.rate' => 'required|numeric',
'products.*.discount' => 'nullable|numeric',
'products.*.tax' => 'required|numeric',
'products.*.amount' => 'required|numeric',
'orderSummary.subTotal' => 'required|numeric',
'orderSummary.totalTax' => 'required|numeric',
'orderSummary.totalDiscount' => 'required|numeric',
'orderSummary.grandTotal' => 'required|numeric',
'orderDate' => 'required|string',
'dueDateForPaymentLink' => 'required|string',
'sendOrderBy.sms' => 'required|boolean',
'sendOrderBy.email' => 'required|boolean',
'sendOrderBy.invoice' => 'required|boolean',
'isCreditCheckAvailable' => 'required|boolean',
'invoiceAsPaymentOption' => 'required|boolean'array',
'customerDetails.type' => 'required|nullable|string',
'customerDetails.countryCode' => 'required|nullable|string',
'customerDetails.msisdn' => 'required|nullable|string',
'customerDetails.email' => 'required|nullable|email',
'customerDetails.name' => 'required|string',
'customerDetails.preferredLanguage' => 'required|string',
'customerDetails.personalNumber' => 'nullable|string|max:11',
'customerDetails.organizationId' => 'required_if:customerDetails.type,corporate|nullable|string|max:9',
'customerDetails.address' => 'required|array',
'customerDetails.address.street' => 'required|string',
'customerDetails.address.zip' => 'required|string',
'customerDetails.address.city' => 'required|string',
'customerDetails.address.country' => 'required|string|in:ISO Alpha 2',
'invoiceReferences'orderDate' => 'nullable|array'required|string',
'invoiceReferences.dueDateForPaymentLink' => 'required|string',
'referenceNo' => 'nullable|string',
'invoiceReferences.customerReference' => 'nullable|string',
'invoiceReferences.receiptNo'sendOrderBy' => 'required|array',
'sendOrderBy.sms' => 'required|boolean',
'sendOrderBy.email' => 'required|boolean',
'products' => 'required|array',
'products.*.name' => 'required|string',
'products.*.productId' => 'nullable|string',
'invoiceReferences.products.*.rate' => 'required|numeric',
'products.*.tax' => 'required|numeric',
'products.*.amount' => 'required|numeric',
'orderSummary.subTotal' => 'required|numeric',
'orderSummary.totalTax' => 'required|numeric',
'orderSummary.grandTotal' => 'required|numeric',
'customerNotes' => 'nullable|string',
'invoiceReferences.tnc' => 'nullable|string',
'internalReferences' => 'nullable|array',
'internalReferences.referenceNo' => 'nullable|string',
'internalReferences.notes' => 'nullable|string',
'submitPayment' => 'required|array',
'submitPayment.via' => 'required|string|in:vipps,visa,mastercard',
'submitPayment.currency' => 'required|string',
'callback' => 'required|array',
'callback.success' => 'required|string',
'callback.failure' => 'required|string'
Example Payload : 
{
    "products": [
        {
            "name": "Router",
            "productId": "R_1",
            "quantity": "1",
            "rate": 4500,
            "discount": 0,
            "tax": "12",
            "amount": 4500
        }
    ],
    "orderSummary"customerDetails": {
        "subTotal"uuid": "4017.86"",
        "totalTax": "482.14",
        "totalDiscount": "0.00",
        "grandTotal": "4500.00"
    },
    "orderDate": "2 Aug, 2023",
    "dueDateForPaymentLink": "1691125906.52",
    "sendOrderBy": {
        "sms": false,
        "email": false,
        "invoice": false
    },
    "invoiceAsPaymentOption": true,
    "isCreditCheckAvailable": false,
    "customerDetails": {
        "type": "private",
        "countryCode": "+47",
        "msisdn": "46567468",
        "email": "[email protected]"[email protected]",
        "name": "Zahidul"420 Test",
        "preferredLanguage": "en",
        "personalNumber": null,
        "organizationId": null,
        "address": {
            "street": "Hatirpool, Dhanmondi 27"Dhaka",
            "zip": "1205"3500",
            "city": "Dhaka"Cumilla",
            "country": "UAE"NO"
        }
    },
    "invoiceReferences"orderDate": "17 Sep, 2023",
    "dueDateForPaymentLink": "1695041918",
    "referenceNo": null,
    "internalReferences"customerReference": null,
    "submitPayment"sendOrderBy": {
        "via"sms": "visa",false,
        "currency"email": "NOK"true
    },
    "callback"products": {
        "success"0": {
            "name": "https://www.frontpayment.no/success"ggg",
            "failure"productId": null,
            "rate": 1000,
            "tax": "https://www.frontpayment.no/failure"0",
            "amount": 1000
        }
    },
    "orderSummary": {
        "subTotal": 1000.00,
        "totalTax": 0,
        "grandTotal": 1000.00
    },
    "customerNotes": null,
    "tnc": null
}
Response Structure : 
{
    "status_code": 202,201,
    "status_message": "OK",
    "message": "OrderReservation Submitted Successfully",
    "is_data": true,
    "data": {
      "orderUuid": "String"
      "paymentUrl"checkoutUrl": "String"
    }
}

{
    "status_code": 500,
    "status_message": "Internal Dependency Error",
    "message": "Internal Error Occurred Please Try Again Later",
    "is_error": true,
    "errors": {
      "happenedAt": "String"
      "internalErrorDetails": "Array"
    }
}

{
    "status_code": 510,
    "status_message": "Execution Exception Occurred",
    "message": "Something Went Wrong",
    "is_error": true,
    "errors": "Array"
}

Example Response : 
{
    "status_code": 202,
    "status_message": "OK",
    "message": "Order Submitted Successfully",
    "is_data": true,
    "data": {.
      "orderUuid": "ODR123456789",
      "paymentUrl"checkoutUrl": "https://v1.checkout.bambora.com/a403d3df20af4888bd8f7dd38f3cd7f1"demo.frontpayment.no/reservations/details/RES1290312908"
    }
}
Back to top