Save Rental Confirm Lyra Payment API

Save Rental Confirm Lyra Payment API Endpoint
StoRegister - Login

Lyra Payment Confirmation for Rental Move-in

This endpoint validates a successful POST request with content type 'application/x-www-form-urlencoded' received from the Lyra payment gateway after a successful payment redirection. It expects the same POST data (formData["kr-answer"]) and initiates the creation of a rental contract, invoice, receipt voucher, and charges entry for the specified booking ID. The resulting contract includes signed documents, addons, and any applicable discounts saved during the move-in flow. The API returns the rental contract ID upon successful completion of the move-in process.

POST
/v1/payment/transaction/lyra/booking/{bookingId}/success
Request Content Type
application/x-www-form-urlencoded
Response Content Type
application/json

Request Header

  • Authorization: X-API-Key string required

    X-API-Key is a string of letters and numbers used to authenticate and control access to the API. It can be generated in the StoRegister management application.

URL Query Parameters:

  • bookingId unique-identifier required

    bookingId refers to an activity ID of the specific booking.

Request Payload:

  • Post Form Data required

    The POST data is expected to be in 'application/x-www-form-urlencoded' format and the specific data needed is retrieved using formData["kr-answer"]

Response Payload:

  • succeeded boolean

    Indicates whether the move-in process was successful. It is a boolean value where true denotes success, and false indicates failure.

  • status string

    Describes the status of the move-in process. It is a string providing additional information about the status.

  • data unique-identifier | null

    Upon success, this property contains the unique identifier representing the rental contract ID associated with the completed move-in process. If the operation is not successful, the value is null.

  • errors array

    Holds error information if applicable. It is an array containing error details in case there are issues with the move-in process.

API Response

{
    "data": "65353E22-C3A6-4600-9DE4-9813D5ECC6B4",
    "succeeded": true,
    "status": "SUCCESS",
    "errors": null
}

Error Codes

  • INVALID_PARAM_BOOKING_ID

    INVALID_PARAM_BOOKING_ID refers to invalid booking ID.

  • INVALID_PARAM_PAYMENT_GATEWAY_MASTER_INFO

    INVALID_PARAM_PAYMENT_GATEWAY_MASTER_INFO refers to payment gateway master ID OR invalid payment gateway.

  • INVALID_PARAM_PAYMENT_GATEWAY_INFO_ID

    INVALID_PARAM_PAYMENT_GATEWAY_INFO_ID refers to payment gateway ID OR invalid payment gateway.

  • PAYMENT_GATEWAY_DETAILS_FAILED

    PAYMENT_GATEWAY_DETAILS_FAILED refers to invalid payment gateway details.

  • INVALID_ACTIVITY_INFO_DETAILS

    INVALID_ACTIVITY_INFO_DETAILS refers to unmatched activity details.

  • ACTIVITY_CALCULATION_FAILED

    ACTIVITY_CALCULATION_FAILED refers to unable to retrive payment amount details.

  • RENTAL_CREATION_FAILED

    RENTAL_CREATION_FAILED refers to unable to create rental(Lease).

  • RENTAL_INVOICE_CREATION_FAILED

    RENTAL_INVOICE_CREATION_FAILED refers to unable to create rental(Lease) invoice.

  • INVALID_PARAM_RCEIPT_INPUT

    INVALID_PARAM_RCEIPT_INPUT refers to unmatched receipt input object.

  • INVALID_PARAM_INVOICE_INFO_ID

    INVALID_PARAM_INVOICE_INFO_ID refers to invoice ID.

  • INVALID_INVOICE_DETAILS

    INVALID_INVOICE_DETAILS refers to unable to retreive invoice details object.

  • INVALID_RENTAL_INFO_DETAILS

    INVALID_RENTAL_INFO_DETAILS refers to unmatched rental details object.

  • INVALID_PARAM_PAYMENT_OBJECT

    INVALID_PARAM_PAYMENT_OBJECT refers to unable to retrive lyra payment object.

  • PAYMENT_PROCESS_FAILED

    PAYMENT_PROCESS_FAILED refers to payment process failed.

  • RECEIPT_CREATION_FAILIED

    RECEIPT_CREATION_FAILIED refers to receipt creation failed in booking process.

  • NO_RECORDS_FOUND

    NO_RECORDS_FOUND means there is no relevant information found.

  • FAILED

    FAILED refers to an unsuccessful API call.

  • SOMETHING_WENT_WRONG

    SOMETHING_WENT_WRONG refers to technical glitch. Please contact administrator.
API Reference documentation