Skip to main content
POST
/
api
/
payments
/
v3
/
accounts
Create a formance account object. This object will not be forwarded to the connector. It is only used for internal purposes. 
curl --request POST \
  --url http://localhost/api/payments/v3/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reference": "<string>",
  "connectorID": "aSDinaTvuI8gbWludGxpZnk=",
  "createdAt": "2023-11-07T05:31:56Z",
  "accountName": "<string>",
  "type": "UNKNOWN",
  "defaultAsset": "<string>",
  "metadata": {}
}
'
{
  "data": {
    "id": "<string>",
    "connectorID": "aSDinaTvuI8gbWludGxpZnk=",
    "provider": "<string>",
    "reference": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "type": "UNKNOWN",
    "raw": {},
    "name": "<string>",
    "defaultAsset": "<string>",
    "metadata": {}
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.formance.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
​
reference
string
required
​
connectorID
string<byte>
required
​
createdAt
string<date-time>
required
​
accountName
string
required
​
type
enum<string>
required
Available options:
UNKNOWN,
INTERNAL,
EXTERNAL
​
defaultAsset
string | null
Pattern: ^[a-zA-Z]{3}\/[0-9]$
​
metadata
object

Response

Created

​
data
object
required