Prepare Amount endpoint

This endpoint takes an amount in piasters, calculates the service fees and returns the total amount.

Note: depending on the agreement with XPay, if your community's service fees are included in bill, you do not need to use this endpoint. skip to next step

REQUEST

Testing server:

POST https://staging.xpay.app/api/v1/payments/prepare-amount/

Production(Live) server:

POST https://community.xpay.app/api/v1/payments/prepare-amount/

Parameters

Do not supply any parameters.

Request body

Required Properties

Property name	Value	Description	Notes
community_id	string	ID that is uniques to your community
amount	float	amount that represents the service cost without service fees

Optional Properties

Property name	Value	Description	Notes
currency	string	amount currency	supported currencies are "EGP", "USD", "EUR", "SAR", "AED", "GBP" and The default currency is EGP and all fees are calculated based on this currency.
selected_payment_method	string	the used payment method "card, fawry, ... etc"	The default payment method is card and all fees are calculated based on this method.

Response

If successful, this method returns a response body with the following structure:

{
    "status": {
        "code": integer,
        "message": string,
        "errors": []
    },

    "data": {
        "total_amount": float
        "total_amount_currency": string
    },
    "count": integer,
    "next": string,
    "previous": string
}

Property name	Value	Description	Notes
total_amount	float	service cost with service fees included	save the value returned in <total_amount> as you will use it later.
total_amount_currency	string	currency

Example

Request Body

{
  "amount": 50,
  "community_id": "zogDmQW",
  "currency": "EGP", // optional: default is "EGP"
  "selected_payment_method": "card" // optional: default is "card"
}

Response Body

{
  "status": {
    "code": 200,
    "message": "success",
    "errors": []
  },
  "data": {
    "total_amount": 50.5,
    "total_amount_currency": "EGP" // default is "EGP"
  },
  "count": null,
  "next": null,
  "previous": null
}