Initiate a payment

POST /api/payments/v3/payment-initiations

Try it

Initiate a payment

cURL

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": {}
}
'

202

{
  "data": {
    "paymentInitiationID": "<string>",
    "taskID": "<string>"
  }
}

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

sourceAccountID · string<byte> | null

destinationAccountID · string<byte>

metadata · object

Show child attributes

metadata. {key} · string

Response

202

application/json

Accepted

data · object · required

Show child attributes

data. paymentInitiationID · string

Related payment initiation object ID created.

data. taskID · string

Will be filled if the noValidation query parameter is set to true. Since this call is asynchronous, the response will contain the ID of the task that was created to create the payment on the PSP. You can use the task API to check the status of the task and get the resulting payment ID