Response Structure |
: |
To access this endpoint, include a Bearer Token in the Authorization header of your request. You can obtain this token from Frontpayment.
Example Authorization Header:
Authorization: Bearer YOUR_FRONTPAID_BEARER_TOKEN
Response
A successful request will return a 200 OK status with the following JSON payload:
// Success
{
"status_code": 200,
"status_message": "OK",
"message": "reservationRetrievedSuccessfully",
"is_data": true,
"data": {
"reservationUuid": "String",
"status": "String",
"isPaid": "Boolean",
"productList": [
{
"id": "Integer",
"name": "String",
"productId": "String",
"quantity": "Float",
"rate": "Float",
"discount": "Float",
"tax": "Integer",
"amount": "Float",
"reserved": "Float",
"captured": "Float"
}
],
"grandTotal": "Float",
"reservationDate": "String",
"paymentLinkDueDate": "String",
"sendOrderBy": {
"sms": "Boolean",
"email": "Boolean"
},
"customerDetails": {
"countryCode": "String",
"msisdn": "String",
"email": "String",
"name": "String",
"address": {
"street": "String",
"zip": "String",
"city": "String",
"country": "String"
}
},
"referenceNumber": "Nullable|String",
"chargeValidity": "Nullable|String",
"customerReference": "Nullable|String",
"customerNotes": "Nullable|String",
"termsAndCondition": "Nullable|String",
"paymentDetails": {
"reservedAt": "Timestamp",
"reservedAmount": "Float",
"capturedAmount": "Float",
"chargedAmount": "Float",
"amountRefunded": {
"fromCaptured": "Float",
"fromCharge": "Float"
}
},
"organizationDetails": {
"name": "String",
"billingAddress": {
"countryCode": "String",
"msisdn": "String",
"email": "String",
"street": "String",
"zip": "String",
"city": "String",
"country": "String"
}
},
"translationKey": "String",
"paymentHistory": {
"reserved": [
{
"at": "String|Timestamp",
"amount": "Float"
}
],
"captured": [
{
"at": "String|Timestamp",
"amount": "Float",
"reference": "String",
"isRefunded": "Boolean",
"refunded": "Float",
"additionalText": "String"
}
],
"charged": [
{
"at": "String|Timestamp",
"amount": "Float",
"reference": "String",
"isRefunded": "Boolean",
"refunded": "Float",
"additionalText": "String"
}
],
"refunded": [
{
"at": "String|Timestamp",
"amount": "Float",
"reference": "String",
"isRefunded": "Boolean",
"isPartial": "Boolean"
}
]
}
}
}
| API
a Example404 Response | error, : | it means requested order with ORDER_UUID could not be found in our system.
{
"status_code": 200,404,
"status_message": "OK"Not Found",
"message": "reservationRetrievedSuccessfully"reservationNotFound",
"is_data": true,false,
"data": null
}
API returns a 510 error, it means something failed on the server side
{
"reservationUuid"status_code": 510,
"status_message": "RES3633019929"Execution Exception Occurred",
"status"message": "RESERVED"Something Went Wrong",
"isPaid"is_error": true,
"productList": [
{
"id": 33,
"name"errors": "Router",
"productId": "R_1",
"quantity": 1,
"rate": 4500,
"discount": 0,
"tax": 12,
"amount": 4500,
"reserved": 0,
"captured": 0Array"
}
],
"grandTotal": 4500,
"reservationDate": "07.08.2023",
"paymentLinkDueDate": "09:05, 09.08.2023",
"sendOrderBy": {
"sms": false,
"email": true
},
"customerDetails": {
"countryCode": "+47",
"msisdn": "46567468",
"email": "[email protected]",
"name": "Kari Nordmann",
"address": {
"street": "Luramyrveien 65",
"zip": "4313",
"city": "Sandnes",
"country": "Norway"
}
},
"referenceNumber": null,
"chargeValidity": 85,
"customerReference": null,
"customerNotes": null,
"termsAndCondition": null,
"paymentDetails": {
"reservedAt": 1691392018,
"reservedAmount": 4500,
"capturedAmount": 0,
"chargedAmount": 11500,
"amountRefunded": {
"fromCaptured": 0,
"fromCharge": 50
}
},
"organizationDetails": {
"name": "Partex",
"billingAddress": {
"countryCode": "+47",
"msisdn": "46567468",
"email": "[email protected]",
"street": "Luramyrveien 65",
"zip": "3933",
"city": "Sandnes",
"country": "Norway"
}
},
"translationKey": "reservationReserved",
"paymentHistory": {
"reserved": [
{
"at": "1691392018",
"amount": 4500
}
],
"captured": [
{
"at": "1693151218",
"amount": 2000,
"reference": "CAP2042342470",
"isRefunded": false,
"refunded": 0,
"additionalText": "Note"
}
],
"charged": [
{
"at": "1693151218",
"amount": 6000,
"reference": "CHA2042342470",
"isRefunded": false,
"refunded": 0,
"additionalText": "Note"
},
{
"at": "1693282899",
"amount": 1500,
"reference": "CHA3690404059",
"isRefunded": false,
"refunded": 0,
"additionalText": ""
},
{
"at": "1693289587",
"amount": 4000,
"reference": "CHA1082664807",
"isRefunded": true,
"refunded": 2000,
"additionalText": ""
}
],
"refunded": [
{
"at": "1710737841",
"amount": 2000,
"reference": "CHA1082664807",
"isRefunded": true,
"isPartial": true
}
]
}
}
}
|
