| Response Structure |
: |
// Success
{
"status_code": 200,
"status_message": "OK",
"message": "reservationRetrievedSuccessfully",
"is_data": true,
"data": [
{
"reservationUuid"uuid": "String",
"status"title": "Slug String",
"datetime": "String",
"isPaid"sentTo": "String|Nullable",
"actionBy": "String|Nullable",
"note": "String|Nullable",
"paymentMethod": "String|Nullable",
"isRefundable": "Boolean",
"productList": [
{
"id"refundAmount": "Integer",
"name": "String",
"productId": "String",
"quantity": "Float",
"rate": "Float",
"discount": "Float",
"tax": "Integer",
"amount": "Float",
"reserved": "Float",
"captured": "Float"String|Nullable"
}
],
"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",
"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",
"refundedAt": "String|Timestamp"
}
],
"charged": [
{
"at": "String|Timestamp",
"amount": "Float",
"reference": "String",
"isRefunded": "Boolean",
"refundedAt": "String|Timestamp"
}
]
}
}
}
|
| Example Response |
: |
{
"status_code": 200,
"status_message": "OK",
"message": "reservationRetrievedSuccessfully",
"is_data": true,
"data": {
"reservationUuid": "RES3633019929",
"status": "RESERVED",
"isPaid": true,
"productList": [
{
"id": 33,
"name"uuid": "Router"RES433140351",
"productId"title": "R_1"payment-link-opened",
"quantity"datetime": 1,"15.01.2024 "rate": 4500,
"discount": 0,
"tax": 12,
"amount": 4500,
"reserved": 0,
"captured": 0
}
]07:37",
"grandTotal"sentTo": 4500,null,
"reservationDate"actionBy": "07.08.2023",null,
"paymentLinkDueDate"note": "09:05, 09.08.2023",null,
"sendOrderBy"paymentMethod": {null,
"sms"isRefundable": 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,
"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": null,
"charged": [
{
"at": "1693151218",
"amount": 6000,
"reference": "CHA2042342470",
"isRefunded": false,
"refundedAt"refundAmount": null
},
{
"at"uuid": "1693282899"RES433140351",
"amount": 1500,
"reference"title": "CHA3690404059"payment-link-sent-to-customer",
"isRefunded"datetime": "15.01.2024 07:36",
"sentTo": " [email protected]",
"actionBy": null,
"note": null,
"paymentMethod": null,
"isRefundable": false,
"refundedAt"refundAmount": null
},
{
"at"uuid": "1693289587"RES3150122585",
"amount": 4000,
"reference"title": "CHA1082664807"payment-link-opened",
"isRefunded": true,
"refundedAt"datetime": "1695638895"14.01.2024 16:07",
"sentTo": null,
"actionBy": null,
"note": null,
"paymentMethod": null,
"isRefundable": false,
"refundAmount": null
},
{
"uuid": "RES3150122585",
"title": "payment-link-sent-to-customer",
"datetime": "10.01.2024 12:57",
"sentTo": " [email protected]",
"actionBy": null,
"note": null,
"paymentMethod": null,
"isRefundable": false,
"refundAmount": null
},
{
"uuid": "RES3062802966",
"title": "payment-link-opened",
"datetime": "10.01.2024 08:23",
"sentTo": null,
"actionBy": null,
"note": null,
"paymentMethod": null,
"isRefundable": false,
"refundAmount": null
},
{
"uuid": "RES3062802966",
"title": "payment-link-sent-to-customer",
"datetime": "10.01.2024 08:22",
"sentTo": " [email protected]",
"actionBy": null,
"note": null,
"paymentMethod": null,
"isRefundable": false,
"refundAmount": null
},
{
"uuid": "RES219006380",
"title": "payment-link-sent-to-customer",
"datetime": "10.01.2024 08:20",
"sentTo": " [email protected]",
"actionBy": null,
"note": null,
"paymentMethod": null,
"isRefundable": false,
"refundAmount": null
},
{
"uuid": "RES2352614380",
"title": "payment-link-opened",
"datetime": "10.01.2024 08:00",
"sentTo": null,
"actionBy": null,
"note": null,
"paymentMethod": null,
"isRefundable": false,
"refundAmount": null
}
]
}
}
}
|
