Skip to main content
GET
Retrieve ACH transfer

Authorizations

Authorization
string
header
required

Use header Authorization: Token <api_token>. API tokens are obtained from the Piriod dashboard.

Headers

x-simple-workspace
string
required

Workspace (account) identifier. Required for every request.

x-piriod-test-mode
boolean
default:false

Whether to operate against test-mode data. Defaults to false.

Path Parameters

id
string
required

Resource identifier.

Response

The transfer.

A bank movement (incoming/outgoing transfer) reconciled against invoices via payment sources.

bank
string
required

Bank account ID.

amount
number
required
currency
string
required
description
string
required
Maximum string length: 256
id
integer
read-only
balance
number
read-only

Remaining unallocated balance.

date
string<date-time> | null
comment
string | null
Maximum string length: 256
number
string | null
Maximum string length: 256
transfer_type
string | null
Maximum string length: 256
auto_match
boolean
default:false
origin_bank
integer | null
origin_id
string | null
Maximum string length: 256
origin_holder_id
string | null
Maximum string length: 256
origin_holder_name
string | null
Maximum string length: 256
origin_number
string | null
Maximum string length: 256
status
enum<string>
default:pending
Available options:
archived,
finalized,
incomplete,
pending
archived
string<date-time> | null
read-only
test_mode
boolean
read-only
created
string<date-time>
read-only
updated
string<date-time>
read-only