v1

latestOpenAPI 3.0.32026-08-0623677345.2 KB
Payments

Create ACH transfer

post/ach_transfers/

Headers

x-simple-workspacestring required

Workspace (account) identifier. Required for every request.

x-piriod-test-modeboolean

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

Request body

idinteger
bankstring required

Bank account ID.

amountnumber required
balancenumber

Remaining unallocated balance.

currencystring required
datestring date-time nullable
descriptionstring required
commentstring nullable
numberstring nullable
transfer_typestring nullable
auto_matchboolean
origin_bankinteger nullable
origin_idstring nullable
origin_holder_idstring nullable
origin_holder_namestring nullable
origin_numberstring nullable
status'archived' | 'finalized' | 'incomplete' | 'pending'
archivedstring date-time nullable
test_modeboolean
createdstring date-time
updatedstring date-time

Response

Transfer created.

idinteger
bankstring required

Bank account ID.

amountnumber required
balancenumber

Remaining unallocated balance.

currencystring required
datestring date-time nullable
descriptionstring required
commentstring nullable
numberstring nullable
transfer_typestring nullable
auto_matchboolean
origin_bankinteger nullable
origin_idstring nullable
origin_holder_idstring nullable
origin_holder_namestring nullable
origin_numberstring nullable
status'archived' | 'finalized' | 'incomplete' | 'pending'
archivedstring date-time nullable
test_modeboolean
createdstring date-time
updatedstring date-time