Skip to main content
POST
/
api
/
payments
/
v3
/
payment-initiations
Initiate a payment
curl --request POST \
  --url http://localhost/api/payments/v3/payment-initiations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reference": "<string>",
  "scheduledAt": "2023-11-07T05:31:56Z",
  "connectorID": "aSDinaTvuI8gbWludGxpZnk=",
  "description": "<string>",
  "type": "UNKNOWN",
  "amount": 123,
  "asset": "<string>",
  "sourceAccountID": "aSDinaTvuI8gbWludGxpZnk=",
  "destinationAccountID": "aSDinaTvuI8gbWludGxpZnk=",
  "metadata": {}
}
'
{
  "data": {
    "paymentInitiationID": "<string>",
    "taskID": "<string>"
  }
}

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.

Query Parameters

​
noValidation
boolean
default:false

If set to true, the request will not have to be validated. This is useful if we want to directly forward the request to the PSP.

Body

application/json
​
reference
string
required
Required string length: 3 - 1000
​
scheduledAt
string<date-time>
required
​
connectorID
string<byte>
required
​
description
string
required
Maximum string length: 10000
​
type
enum<string>
required
Available options:
UNKNOWN,
TRANSFER,
PAYOUT
​
amount
integer<bigint>
required
​
asset
string
required
Pattern: ^[a-zA-Z]{3}\/[0-9]$
​
sourceAccountID
string<byte> | null
​
destinationAccountID
string<byte>
​
metadata
object

Response

Accepted

​
data
object
required