{
"id": "019bdb2a-960f-789d-8955-21720e6cdef0",
"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",
"address": {
"townName": "Vilnius",
"streetName": "Gedimino pr.",
"buildingNumber": "1",
"postCode": "01103",
"country": "LT"
}
},
"amount": 10000,
"currency": "EUR",
"remittanceInformation": "Invoice payment #12345",
"status": "PENDING",
"scheme": "SCT",
"direction": "OUTBOUND",
"source": "CLIENT",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z",
"debtorPartyId": "019bdb2a-960f-789d-8955-21720e6cdef1",
"debtorAccountId": "019bdb2a-960f-789d-8955-21720e6cdef2",
"creditorPartyId": "019bdb2a-960f-789d-8955-21720e6cdef3",
"creditorAccountId": "019bdb2a-960f-789d-8955-21720e6cdef4",
"endToEndId": "E2E-123456",
"settlementDate": "2024-01-15T00:00:00.000Z"
}{
"outcome": "ACCEPTED",
"postings": [
{
"destination": "INTERNAL:CLEARING:FEES",
"amount": 100,
"details": "Transaction fee",
"type": "FEES"
}
],
"rejectionCode": "AG01"
}Request payment oversight decision
Ledger sends a POST request with payment details for an oversight decision. Returns 200 with an outcome of ACCEPTED or REJECTED.
{
"id": "019bdb2a-960f-789d-8955-21720e6cdef0",
"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",
"address": {
"townName": "Vilnius",
"streetName": "Gedimino pr.",
"buildingNumber": "1",
"postCode": "01103",
"country": "LT"
}
},
"amount": 10000,
"currency": "EUR",
"remittanceInformation": "Invoice payment #12345",
"status": "PENDING",
"scheme": "SCT",
"direction": "OUTBOUND",
"source": "CLIENT",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z",
"debtorPartyId": "019bdb2a-960f-789d-8955-21720e6cdef1",
"debtorAccountId": "019bdb2a-960f-789d-8955-21720e6cdef2",
"creditorPartyId": "019bdb2a-960f-789d-8955-21720e6cdef3",
"creditorAccountId": "019bdb2a-960f-789d-8955-21720e6cdef4",
"endToEndId": "E2E-123456",
"settlementDate": "2024-01-15T00:00:00.000Z"
}{
"outcome": "ACCEPTED",
"postings": [
{
"destination": "INTERNAL:CLEARING:FEES",
"amount": 100,
"details": "Transaction fee",
"type": "FEES"
}
],
"rejectionCode": "AG01"
}Response Handling
Ledger expects a 200 response with anOversightResponse body. The outcome field determines whether the payment is accepted or rejected.
Fallback behavior — If your endpoint returns a non-200 status code, an invalid response body, or times out, Ledger applies a fallback based on payment direction:
- Outbound payments — Ledger rejects the payment with rejection code
MS03. - Inbound payments — Ledger accepts the payment with no additional postings.
Accepting a payment
Returnoutcome: "ACCEPTED" with an optional array of additional postings to execute alongside the payment.
destination needs to be specified.
{
"outcome": "ACCEPTED",
"postings": [
{
"destination": "INTERNAL:CLEARING:FEES",
"amount": 100,
"details": "Transaction fee"
}
]
}
{
"outcome": "ACCEPTED"
}
Rejecting a payment
Returnoutcome: "REJECTED" with an optional rejection code. If the code is not provided or unrecognized, it defaults to MS03.
MS03 if omitted. Supported values:| Code | Description |
|---|---|
AG01 | Credit transfer forbidden on this type of account |
AG02 | Invalid operation code or transaction format |
AM05 | Duplicate payment |
BE04 | Invalid account address |
MD07 | Beneficiary deceased |
MS02 | By order of the beneficiary |
MS03 | Reason not specified (default) |
RR01 | Missing debtor account or identification |
RR02 | Missing debtor name or address |
RR03 | Missing creditor name or address |
RR04 | Other regulatory reason (AML, sanctions screening, etc.) |
{
"outcome": "REJECTED",
"rejectionCode": "RR04"
}
Body
Payment oversight decision request
Payment ID
[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"019bdb2a-960f-789d-8955-21720e6cdef0"
Debtor details
Show child attributes
Show child attributes
Creditor details
Show child attributes
Show child attributes
Payment amount in minor units
10000
Currency code
"EUR"
Payment description/reference
"Invoice payment #12345"
Payment status
PENDING "PENDING"
Payment scheme
SCT, SCT_INST, INTERNAL, SWIFT "SCT"
Payment direction
INBOUND, OUTBOUND "OUTBOUND"
Business source that initiated the payment
CLIENT, PLAIS, EXTERNAL_BANK "CLIENT"
Creation timestamp
"2024-01-15T10:30:00.000Z"
Last update timestamp
"2024-01-15T10:30:00.000Z"
Debtor party ID
[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"019bdb2a-960f-789d-8955-21720e6cdef1"
Debtor account ID
[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"019bdb2a-960f-789d-8955-21720e6cdef2"
Creditor party ID
[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"019bdb2a-960f-789d-8955-21720e6cdef3"
Creditor account ID
[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"019bdb2a-960f-789d-8955-21720e6cdef4"
End-to-end identifier
"E2E-123456"
Settlement date
"2024-01-15T00:00:00.000Z"
Response
Oversight decision
- Option 1
- Option 2
Oversight decision response
Decision outcome
ACCEPTED "ACCEPTED"
Additional postings to execute (present when accepted)
Show child attributes
Show child attributes
Rejection code
AG01, AG02, AM05, BE04, MD07, MS02, MS03, RR01, RR02, RR03, RR04