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.
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.
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: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
Creditor details
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