Skip to main content
POST
Submit check deposit
This feature is in Beta and not ready for production integration.

Authorizations

Authorization
string
header
required

User OAuth2 access token (authorization code with PKCE).

Path Parameters

id
string<uuid>
required

The bank account ID.

Body

Request model for submitting a remote check deposit against a bank account.

amount
required

Amount read off the check, in minor units, as entered by the operator. Must be greater than 0. Need not match the invoice total: a partial payment, an exact payment and an overpayment are all accepted.

currencyCode
string
default:USD

ISO 4217 alphabetic currency code (e.g. USD). Defaults to USD when omitted. Determines the minor unit precision of long CreateCheckDepositRequest.Amount.

invoiceId
null | string<uuid>

Optional invoice to record this payment against. When supplied, the payment is recorded with the finance operations service as part of the same unit of work as the deposit: if that call fails, the deposit fails and no record is kept.

Response

Deposit submitted.

A submitted remote check deposit.

id
string<uuid>
required

Unique identifier for the deposit.

amount
object
required

Deposited amount, in minor units.

availableOn
string<date>
required

Estimated date the deposited funds become available.

invoiceId
null | string<uuid>

Invoice the payment was recorded against, when one was supplied.