Skip to main content
POST
Create a Reserve Account

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

The reserve to create

account_id
string
required

ID of the target Account that has an added reserve limit. Filterable.

amount
string
required

Amount that account_id is currently overdrawn

Pattern: ^-?[0-9]+[.][0-9][0-9]$
reserve_account_id
string
required

ID of the Account that holds the reserve. Filterable.

upper_limit
string
required

Max amount that account_id may be overdrawn in total

Pattern: ^-?[0-9]+[.][0-9][0-9]$
bankdata
object

Optional data for the bank

userdata
object

Arbitrary user data that can be attached to the object

Response

200 - application/json

The reserve created

account_id
string

ID of the target Account that has an added reserve limit. Filterable.

amount
string

Amount that account_id is currently overdrawn

Pattern: ^-?[0-9]+[.][0-9][0-9]$
bankdata
object

Optional data for the bank

id
string

Unique identifier for object

reserve_account_id
string

ID of the Account that holds the reserve. Filterable.

upper_limit
string

Max amount that account_id may be overdrawn in total

Pattern: ^-?[0-9]+[.][0-9][0-9]$
userdata
object

Arbitrary user data that can be attached to the object