Skip to main content
POST
/
payments
Initiate payment
curl --request POST \
  --url https://api.example.com/payments \
  --header 'Content-Type: application/json' \
  --data '
{
  "correlationId": "019bdb2a-960f-789d-8955-21720e6cdef0",
  "paymentScheme": "SCT",
  "debtor": {
    "clientPartyId": "019bdb2a-960f-789d-8955-21720e6cdeee",
    "accountId": "019bdb2a-960f-789d-8955-21720e6cdeef"
  },
  "creditor": {
    "name": "Jane Smith",
    "account": {
      "iban": "DE89370400440532013000"
    },
    "agent": "REVOLT21"
  },
  "instructedAmount": {
    "amount": 10000,
    "currency": "EUR"
  },
  "remittanceInformation": "Invoice payment #12345",
  "endToEndId": "E2E-123456"
}
'
{
  "type": "https://api.ledger.finventi.com/errors/bad-request",
  "title": "Bad Request",
  "status": 400,
  "detail": "Invalid request body: correlationId is required",
  "instance": "/accounts/019bdb2a-960f-789d-8955-21720e6cdeed"
}

Body

application/json

Request to create a payment transaction

​
correlationId
string<uuid>
required

Unique correlation identifier for tracking the request

Example:

"019bdb2a-960f-789d-8955-21720e6cdef0"

​
paymentScheme
enum<string>
required

Payment scheme

Available options:
SCT,
SCT_INST
Example:

"SCT"

​
debtor
object
required

Debtor (payer) information

​
creditor
object
required

Creditor (payee) information

​
instructedAmount
object
required

Payment amount

​
remittanceInformation
string
required

Payment description/reference

Example:

"Invoice payment #12345"

​
endToEndId
string | null

End-to-end identifier

Example:

"E2E-123456"

Response

Payment initiation accepted