Deposit

Deposit is the act of placing cash or cash equivalent with a financial institution such as a bank. It consists of:

Cash: Deposit Cash from the Vendor Account to the managed Sleeve Account.
Checks: Deposit Checks from the Vendor Account to the managed Sleeve Account.
- Check Scanning: Scan the check to be deposited.
- Generating ICL.
Electronic Deposit: ACH request from the Vendor’s bank to pull money into the managed Sleeve Account.

List Deposit

Use the /api/v2/services/money-movements/deposits to list deposits.

Action: GET
Endpoint: api/v2/services/money-movements/deposits

Responses

Code	Status
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

Response Body

Fields	Data Type	Description	Sample	Required or Not
name	String	Name of the payee	Austin Capital Trust Company LLC Checking	Required
serviceType	Enum	Service type selected for the deposit	Bank Wire	Optional
accountNumber	String	Account number of the payee	1-32-03-01-002154	Required
unifiedAccountId	String	Unified Account Id of the payee	a058c00000f1cagAAA	Required
createdDate	Date	Created date of the deposit	2022-08-16T20:09:37	Required
recordTypeId	String	Record type Id of the deposit	0128c000002j056AAA	Required
acId	String	Acceleration Cloud Id of the payee	a098c00000toisnAAA	Required

Sample Response Body

Create a Check Deposit Transaction

Action:POST
Endpoint: api/v2/services/money-movements/deposits/check

Create a new deposit to apply toward a managed sleeve account’s balance.

Request Body

Fields	Data Type	Description	Sample	Required or Not
amount	Number	The amount to receive	1.05	Optional
bankAccountNumber	String	Bank account number	1234314	Required
bankName	String	Bank name of the check		Optional
bankRoutingNumber	String	Rounting number of the bank	111000666	Required
checkBackImage	String	Back image of the check		Required
checkDate	Date	Date of the check	2022-11-11	Optional
checkFrontImage	String	Front image of the check		Required
checkNumber	String	Check number	33333333333	Required
fee	Number	Transaction fee to be charged	3.05	Optional
memo	String	Additional text describing the transaction	Gift purpose	Optional
payeeAccountId	String	Account Id of the payee		Required
payeeUserId	String	User Id of the payee		Required
payerId	String	Managed sleeve account Id	"B57A"	Optional
payerType	String	Type of the payer		Optional
paymentType	String	Payment type used by the payer	Bank wire	Optional
scheduleDate	Date	Actual date of money movent	2022-10-12	Optional
source	String	Indicate where API call comes from		Optional

Sample Request Body

{
  "amount": 50,
  "memo": "Gift",
  "payeeBankId": "A125VC",
  "payeeId": "A2135VC",
  "payerId": "CA125VC",
  "scheduledDate": "2022-11-08",
  "transferType": "EFT"
}

Responses

Code	Status
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response Body

Fields	Data Type	Description	Sample	Required or Not

Sample Response Body

{
    "ownerName": null,
    "vendor": null,
    "checkStub": null,
    "checkDate": null,
    "vendorEmail": "[email protected]",
    "daytimePhone": null,
    "accountToAccountPayee": null,
    "recordTypeId": "0128c000002aGI1AAM",
    "completedDate": null,
    "contactAsVendorId": null,
    "ssnTaxPayerId": null,
    "party": null,
    "checkNumber": null,
    "lastName": "Test Account 2",
    "payToAccount": null,
    "scheduleDate": "2022-04-07",
    "name": "Payment request from client - 0038c00002jgjHAAAY",
    "actualPickUpDate": null,
    "bankInfoId": null,
    "accountNumber": "132412433214",
    "transferType": "EFT",
    "memo": null,
    "bankName": null,
    "firstName": null,
    "swiftCode": null,
    "amount": 103,
    "isConfirmed": false,
    "createdDate": "Apr 07,2022 03:26 PM",
    "sleeveAccountId": "a098c00000sy3szAAA",
    "paymentType": "Immediately",
    "overnightMail": false,
    "destinationCountry": null,
    "careOf": null,
    "bankRoutingNumber": null,
    "feeApplied": 35,
    "accountAsVendorId": "0018c00002GzMp3AAF",
    "amountType": null,
    "requestedPickupDate": null,
    "accountType": null,
    "submitterId": "0038c00002jgjHAAAY",
    "address": "123 main street",
    "city": "DALLAS",
    "state": "TX",
    "zipCode": "75252",
    "id": 8,
    "acId": "a0T8c00000b3ZS0EAM",
    "status": "In_Progress_1",
    "step": "Process_2",
    "fullBankAccountNumber": null,
    "intermediaryRoutingNumber": null,
    "intermediaryFinancialInstitution": null,
    "achBatchId": null
}

Scan a Check

Use the /api/v2/services/money-movements/deposits/check/smas/{smaSfid}/scan to scan the check received.

Action:POST
Endpoint: /api/v2/services/money-movements/deposits/check/smas/{smaSfid}/scan

Scan the check signed and issued by the bank of the payer.

URL Path Parameters

Fields	Data Type	Description	Sample	Required or Not
smaSfid	String	Sfid of the managed sleeve account		Required

Request Body

Fields	Data Type	Description		Required or Not
amount	Number	Amount to be deposited	1000	Required
frontimage	String	Front imamge of the check		Required
rearimage	String	Rear image of the check		Required

Sample Request Body

{
     "amount": 0,
     "frontimage": "string",
     "rearimage": "string"
}
'

Responses

Code	Status
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response Body

Fields	Data Type	Description	Sample	Required or Not

Sample Response Body

{
  "code": 600,
  "errorMessage": "token invalid"
}