POST 17.0/app/payments/clearedfunds

Description

Checks if cleared funds are available based on the provided request details.

URI Parameters

None.

The request object containing contact and bank account identifiers.

ClearedFundsRequest
Name Description Type Additional information
ContactId

integer

None.
BankAccountId

integer

None.

application/json, text/json
Sample: 
{
  "contactId": 1,
  "bankAccountId": 2
}

application/xml, text/xml
Sample: 
<ClearedFundsRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ContactId>1</ContactId>
  <BankAccountId>2</BankAccountId>
</ClearedFundsRequest>

application/x-www-form-urlencoded
Sample:

Sample not available.

True if cleared funds are available; otherwise, false.

boolean

application/json, text/json
Sample: 
true

application/xml, text/xml
Sample: 
<boolean>true</boolean>