get Sign In Payload

protected open fun getSignInPayload(email: String, password: String, vararg custom: Any?): APIRequest.Params

Function to create the payload for the signIn request.

Usage example:

@CustomParametersOrder(order = ["currency"])
override fun getSignInPayload(email: String, password: String, vararg custom: Any?): Params {
val payload = super.getSignInPayload(email, password)
payload.addParam("currency", custom[0])
return payload
}

Return

the payload for the request as Params

Parameters

email

: the email of the user

password

: the password of the user

custom

: the custom parameters added in a customization of the EquinoxUser to execute a customized sign-in