Skip to main content

Submit Reservation

With thisThis API endpoint,allows youthird-party cansystems exportto create reservations and redirect customers to Front Payment Go and geta checkout URLspage infor return.completing payments.

Step

1:Submit

Validation Rules

Reservation

Endpoint

 :POST [https://demo-api.frontpayment.no/api/v1/connect/reservations/submit
Method:POST
Authorization:Bearer
Payload Validations: 
'customerDetails' => 'required|array',
'customerDetails.customerUuid' => 'required|string',
'customerDetails.type' => 'required|string|in:private,corporate',
'customerDetails.countryCode' => 'required|string',
'customerDetails.msisdn' => 'required|string',
'customerDetails.email' => 'required|email',
'customerDetails.name' => 'required|string',
'customerDetails.preferredLanguage' => 'required|string',
'customerDetails.personalNumber' => 'nullable|string|size:11',
'customerDetails.organizationId' => 'required_if:customerDetails.type,corporate|nullable|string|regex:/^[a-zA-Z0-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',
'orderDate' => 'required|string',
'dueDateForPaymentLink' => 'required|string',
'referenceNo' => 'nullable|string',
'customerReference' => 'nullable|string',
'sendOrderBy' => 'required|array',
'sendOrderBy.sms' => 'required|boolean',
'sendOrderBy.email' => 'required|boolean',
'products' => 'required|array',
'products.*.name' => 'required|string',
'products.*.productId' => 'nullable|string',
'products.*.rate' => 'required|numeric',
'products.*.tax' => 'required|numeric|in:0,12,15,25 submit](Unless you have other configuration)',
'products.*.amount' => 'required|numeric',
'orderSummary.subTotal' => 'required|numeric',
'orderSummary.totalTax' => 'required|numeric',
'orderSummary.grandTotal' => 'required|numeric',
'chargeValidity' => 'nullable|string|regex:/^\d+$/',  https://demo-api.frontpayment.no/api/v1/connect/reservations/submit)

charge

Authentication

This endpoint requires a Bearer Token for authentication. You will beneed availableto forobtain 90this daystoken iffrom nullFront givenPayment 'customerNotes'and =>include 'nullable|string',it 'tnc'in =>the 'nullable|string',Authorization 'settings'header =>of 'sometimes|array',your 'settings.isChargePartiallyRefundable'request.

=> 'sometimes|boolean'

Example Authorization Header: Authorization: Bearer YOUR_FRONTPAID_BEARER_TOKEN

Request Payload

: 
{
  "customerDetails": {
    "uuid": "",
    "type": "private",
    "countryCode": "+47"880",
    "msisdn": "46567468"1724313009",
    "email": "[email protected]"[email protected]",
    "name": "Kari Nordmann"Nafees",
    "preferredLanguage": "en",
    "personalNumber": null,"19635464524",
    "organizationId": null,
    "address": {
      "street": "Luramyrveien 65"Dhaka",
      "zip": "4313"3500",
      "city": "Sandnes"Cumilla",
      "country": "NO"
    }
  },
  "orderDate": "1703 Sep, 2023"2025",
  "dueDateForPaymentLink": "1695041918"1756871295",
  "referenceNo": null,
  "customerReference": null,
  "sendOrderBy": {
    "sms": false,
    "email": true
  },
  "products": {
    "0": {
      "name": "Test",
      "productId": null,
      "rate": 1000,1,
      "tax": "0",
      "amount": 10001
    }
  },
  "orderSummary": {
    "subTotal": 1000.00,1,
    "totalTax": 0,
    "grandTotal": 1000.001
  },
  "chargeValidity" : "55",
  "customerNotes": null,
  "tnc": null,
  "settings": {
    "secureDetails": false,
    "isChargePartiallyRefundable": truefalse
  },
  "callback": {
    "callbackUrl": "https://wp.frontpayment.no"
  }
}

FieldTypeDescription
customerDetailsarrayRequired. Customer details information.
customerDetails.typestringRequired. Customer type (private or corporate).
customerDetails.countryCodestringRequired. Country dialing code (e.g., +880).
customerDetails.msisdnstringRequired. Mobile phone number without country code.
customerDetails.emailemailRequired. Valid customer email address.
customerDetails.namestringRequired. Full name of the customer.
customerDetails.preferredLanguagestringRequired. Preferred language (e.g., en, no).
customerDetails.personalNumberstringOptional. Must be exactly 11 digits if provided.
customerDetails.organizationIdstringRequired if type=corporate. Alphanumeric only.
customerDetails.addressarrayRequired. Customer address details.
customerDetails.address.streetstringRequired. Street name.
customerDetails.address.zipstringRequired. Postal code.
customerDetails.address.citystringRequired. City name.
customerDetails.address.countrystringRequired. Country code (ISO format).
orderDatestringRequired. Reservation order date.
dueDateForPaymentLinkstringRequired. Expiry timestamp for payment link.
referenceNostringOptional. Internal reference number.
customerReferencestringOptional. Customer’s reference number.
sendOrderByarrayRequired. Defines communication channels (SMS, email).
sendOrderBy.smsbooleanRequired. Whether to send via SMS.
sendOrderBy.emailbooleanRequired. Whether to send via Email.
productsarrayRequired. List of products in the order.
products.*.namestringRequired. Product name.
products.*.productIdstringOptional. Product ID (max 25 chars).
products.*.ratenumericRequired. Unit rate.
products.*.taxnumericRequired. Tax value.
products.*.amountnumericRequired. Quantity of product.
orderSummary.subTotalnumericRequired. Subtotal of products.
orderSummary.totalTaxnumericRequired. Total tax amount.
orderSummary.grandTotalnumericRequired. Final payable amount.
customerNotesstringOptional. Customer-provided notes.
tncstringOptional. Terms & Conditions.
chargeValiditystringOptional. Must be numeric string.
settingsarrayOptional. Additional settings.
settings.secureDetailsbooleanOptional. Indicates secure details requirement.
settings.isChargePartiallyRefundablebooleanOptional. Whether partial refunds are allowed.
callbackarrayOptional. Callback configuration.
callback.callbackUrlurlOptional. URL to receive payment notifications.
---

Example Success Response Structure : 

{
  "status_code": 201,
  "status_message": "OK",
  "message": "Reservation Submitted Successfully",
  "is_data": true,
  "data": {
    "customerUuid":"String", "orderUuid": "String",
      "checkoutUrl": "String"
    }
}

{
    "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": {.
      "customerUuid":"CSRT1098785092"CSRT1358046874",
    "reservationUuid": "RES3855804929"RES1943140879",
    "checkoutUrl": "https://demo.stg.frontpayment.no/reservations/details/RES3855804929"RES1943140879"
  }
}

Step 2: Redirect to Checkout

After receiving a successful response, the customer should be redirected to the checkoutUrl provided. At checkout, the customer can choose from supported payment methods:

  • Vipps
  • Google Pay
  • Visa
  • Mastercard

Once the payment is completed successfully, the user will be redirected to a success page.

Step 3: Callback Notification

After payment, the third-party system will be notified via the callbackUrl provided in the reservation request.

📌 See Callback URL Documentation for details.

Back to top