Create an Account
POST/v1/accounts
Creates a new Organization Account. The name of the Account must be unique within the Organization. The three-letter ISO 4217 currency code specifies the currency of the Account, and cannot be updated after creation.
Request
- application/json
Body
The request received from the client.
A name for the Account. Must be unique within the Organization.
(Optional) A description for the Account.
lowBalance
object
Account low balance settings
Whether a notification should be sent if the Account balance is low
The email address to which to send a notification.
threshold
object
required
Represents an amount of money with its currency type.
The whole units of the amount.
For example if currencyCode
is "USD"
, then 1 unit is one US dollar.
Number of nano (10^-9) units of the amount.
The value must be between -999,999,999 and +999,999,999 inclusive.
If units
is positive, nanos
must be positive or zero.
If units
is zero, nanos
can be positive, zero, or negative.
If units
is negative, nanos
must be negative or zero.
For example $-1.75 is represented as units
=-1 and nanos
=-750,000,000.
Responses
- 200
- default
OK
- application/json
- Schema
- Example (from schema)
Schema
account
object
required
An account
The identifier for the Account.
The name of the Account.
(Optional) The description of the Account.
balance
object
required
Represents an amount of money with its currency type.
The whole units of the amount.
For example if currencyCode
is "USD"
, then 1 unit is one US dollar.
Number of nano (10^-9) units of the amount.
The value must be between -999,999,999 and +999,999,999 inclusive.
If units
is positive, nanos
must be positive or zero.
If units
is zero, nanos
can be positive, zero, or negative.
If units
is negative, nanos
must be negative or zero.
For example $-1.75 is represented as units
=-1 and nanos
=-750,000,000.
lowBalance
object
Account low balance settings
Whether a notification should be sent if the Account balance is low
The email address to which to send a notification.
threshold
object
required
Represents an amount of money with its currency type.
The whole units of the amount.
For example if currencyCode
is "USD"
, then 1 unit is one US dollar.
Number of nano (10^-9) units of the amount.
The value must be between -999,999,999 and +999,999,999 inclusive.
If units
is positive, nanos
must be positive or zero.
If units
is zero, nanos
can be positive, zero, or negative.
If units
is negative, nanos
must be negative or zero.
For example $-1.75 is represented as units
=-1 and nanos
=-750,000,000.
{
"account": {
"accountId": "string",
"name": "string",
"description": "string",
"balance": {
"currencyCode": "string",
"units": "string",
"nanos": 0
},
"lowBalance": {
"hasNotification": true,
"notificationEmail": "string",
"threshold": {
"currencyCode": "string",
"units": "string",
"nanos": 0
}
}
}
}
Error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
An error status code describing the response.
Enum Value | Description |
---|---|
0 | OK |
1 | Cancelled |
2 | Unknown |
3 | InvalidArgument |
4 | DeadlineExceeded |
5 | NotFound |
6 | AlreadyExists |
7 | PermissionDenied |
8 | ResourceExhausted |
9 | FailedPrecondition |
10 | Aborted |
11 | OutOfRange |
12 | Unimplemented |
13 | Internal |
14 | Unavailable |
15 | DataLoss |
16 | Unauthenticated |
Possible values: [0
, 1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 10
, 11
, 12
, 13
, 14
, 15
, 16
]
A developer-facing error message
details
object[]
A list of messages containing details about the errors
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}