Skip to main content
POST
Import a settlement file

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Body

application/json
label
string
required

Name the import so it can be found again.

lines
object[]
required
Required array length: 1 - 5000 elements
gateway
enum<string>

The processor the file came from.

Available options:
stripe,
square,
zeffy,
paypal,
venmo,
cashapp,
other
period_start
string<date>

The first day the file covers. With period_end, it lets the import list payments recorded in that time that the file does not account for.

period_end
string<date>

Response

The import, with its counts.

reconciliation
object
required

One import of a processor's settlement file, with its counts.