Skip to main content
POST
/
api
/
payments
/
v3
/
payments
Create a formance payment 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/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reference": "<string>",
  "connectorID": "aSDinaTvuI8gbWludGxpZnk=",
  "createdAt": "2023-11-07T05:31:56Z",
  "type": "UNKNOWN",
  "initialAmount": 123,
  "amount": 123,
  "asset": "<string>",
  "scheme": "<string>",
  "sourceAccountID": "aSDinaTvuI8gbWludGxpZnk=",
  "destinationAccountID": "aSDinaTvuI8gbWludGxpZnk=",
  "metadata": {},
  "adjustments": [
    {
      "reference": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "status": "UNKNOWN",
      "amount": 123,
      "asset": "<string>",
      "metadata": {}
    }
  ]
}
'
{
  "data": {
    "id": "<string>",
    "connectorID": "aSDinaTvuI8gbWludGxpZnk=",
    "provider": "<string>",
    "reference": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "type": "UNKNOWN",
    "initialAmount": 123,
    "amount": 123,
    "asset": "<string>",
    "scheme": "<string>",
    "status": "UNKNOWN",
    "sourceAccountID": "aSDinaTvuI8gbWludGxpZnk=",
    "destinationAccountID": "aSDinaTvuI8gbWludGxpZnk=",
    "metadata": {},
    "adjustments": [
      {
        "id": "<string>",
        "reference": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "status": "UNKNOWN",
        "raw": {},
        "amount": 123,
        "asset": "<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
​
type
enum<string>
required
Available options:
UNKNOWN,
PAY-IN,
PAYOUT,
TRANSFER,
OTHER
​
initialAmount
integer<bigint>
required
​
amount
integer<bigint>
required
​
asset
string
required
Pattern: ^[a-zA-Z]{3}\/[0-9]$
​
scheme
string
required
​
sourceAccountID
string<byte>
​
destinationAccountID
string<byte>
​
metadata
object
​
adjustments
object[]

Response

Created

​
data
object
required