Skip to main content
POST
Create ACH adjustment

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.

Body

application/json

Manual adjustment applied to an ACH transfer (e.g. to balance fees).

transfer
integer
required

ACH transfer ID.

amount
number
required
operation
enum<string>
required
Available options:
add,
sub,
exchange
currency
string | null
base_amount
number | null
base_currency
string | null
comment
string | null
Maximum string length: 256

Response

201 - application/json

Adjustment created.

Manual adjustment applied to an ACH transfer (e.g. to balance fees).

transfer
integer
required

ACH transfer ID.

amount
number
required
operation
enum<string>
required
Available options:
add,
sub,
exchange
id
integer
read-only
currency
string | null
base_amount
number | null
base_currency
string | null
comment
string | null
Maximum string length: 256
created
string<date-time>
read-only