POST ValidateUserFunds

Request Information

URI Parameters

None.

Body Parameters

UserBalanceCheckModel
NameDescriptionTypeAdditional information
UserId

string

None.

Amount

decimal number

None.

Request Formats

application/json, text/json

Sample:
{
  "UserId": "sample string 1",
  "Amount": 2.1
}

application/xml, text/xml

Sample:
<UserBalanceCheckModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ZakaPayAPI.Models">
  <Amount>2.1</Amount>
  <UserId>sample string 1</UserId>
</UserBalanceCheckModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ValidateFundsResultModel
NameDescriptionTypeAdditional information
UserId

string

None.

RequestedAmount

decimal number

None.

AvailableBalance

decimal number

None.

HasSufficientFunds

boolean

None.

ShortfallAmount

decimal number

None.

IsValid

boolean

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "UserId": "sample string 1",
  "RequestedAmount": 2.1,
  "AvailableBalance": 3.1,
  "HasSufficientFunds": true,
  "ShortfallAmount": 5.1,
  "IsValid": true,
  "Message": "sample string 7"
}

application/xml, text/xml

Sample:
<ValidateFundsResultModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ZakaPayAPI.Models">
  <AvailableBalance>3.1</AvailableBalance>
  <HasSufficientFunds>true</HasSufficientFunds>
  <IsValid>true</IsValid>
  <Message>sample string 7</Message>
  <RequestedAmount>2.1</RequestedAmount>
  <ShortfallAmount>5.1</ShortfallAmount>
  <UserId>sample string 1</UserId>
</ValidateFundsResultModel>