Skip to main content

Response Handling

The endpoint always returns 200 with an OversightResponse. The outcome field determines whether the payment is accepted or rejected. Fallback behavior — If the oversight endpoint returns a non-200 response or times out, the system applies a fallback based on payment direction:
  • Outbound payments are rejected.
  • Inbound payments are accepted with no additional postings.
outcome
string
required
Decision outcome. Either ACCEPTED or REJECTED.

Accepting a payment

Return outcome: "ACCEPTED" with an optional array of additional postings to execute alongside the payment.
postings
array
Additional postings to execute alongside the payment
The source account for each posting defaults to the party’s account from the payment — the debtor account for outgoing payments and the creditor account for incoming payments. Only the destination needs to be specified. Accept with additional postings:
200
{
  "outcome": "ACCEPTED",
  "postings": [
    {
      "destination": "INTERNAL:CLEARING:FEES",
      "amount": 100,
      "currency": "EUR",
      "details": "Transaction fee"
    }
  ]
}
Accept without additional postings:
200
{
  "outcome": "ACCEPTED",
  "postings": []
}

Rejecting a payment

Return outcome: "REJECTED" with an optional rejection code. If the code is not provided or unrecognized, it defaults to MS03.
rejectionCode
string
Rejection reason code. Optional — defaults to MS03 if omitted. Supported values:
CodeDescription
AG01Credit transfer forbidden on this type of account
AG02Invalid operation code or transaction format
AM05Duplicate payment
BE04Invalid account address
MD07Beneficiary deceased
MS02By order of the beneficiary
MS03Reason not specified (default)
RR01Missing debtor account or identification
RR02Missing debtor name or address
RR03Missing creditor name or address
RR04Other regulatory reason (AML, sanctions screening, etc.)
200
{
  "outcome": "REJECTED",
  "rejectionCode": "RR04"
}

Request Example

Ledger sends a POST request with the payment details as the body:
{
  "id": "019bdb2a-960f-789d-8955-21720e6cdef0",
  "debtorPartyId": "019bdb2a-960f-789d-8955-21720e6cdef1",
  "debtorAccountId": "019bdb2a-960f-789d-8955-21720e6cdef2",
  "creditorPartyId": "019bdb2a-960f-789d-8955-21720e6cdef3",
  "creditorAccountId": "019bdb2a-960f-789d-8955-21720e6cdef4",
  "debtor": {
    "name": "John Doe",
    "iban": "LT601010012345678901",
    "currency": "EUR",
    "agent": "REVOLT21",
    "address": {
      "townName": "Vilnius",
      "streetName": "Gedimino pr.",
      "buildingNumber": "1",
      "postCode": "01103",
      "country": "LT"
    }
  },
  "creditor": {
    "name": "Jane Smith",
    "iban": "DE89370400440532013000",
    "currency": "EUR",
    "agent": "DEUTDEFF"
  },
  "amount": 10000,
  "currency": "EUR",
  "endToEndId": "E2E-123456",
  "remittanceInformation": "Invoice payment #12345",
  "status": "PENDING",
  "scheme": "SCT",
  "direction": "OUTBOUND",
  "settlementDate": "2024-01-15",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}