Declare an instruction not executed
POST/api/v1/payment_batches/:id/settlement/instructions/:payment_instruction_id/not_executed
Declares that the payment of an instruction whose execution is to be confirmed (execution_to_confirm_at is set) was never executed, for a batch handed over as a SEPA file. The instruction reads rejected, carries the declaration, and its invoice is no longer reserved: a new batch may pay it. Nothing is resubmitted and the bank's status reports are kept. A batch paid through a bank consent is refused: only the bank's rejection or a confirmed bank operation resolves its instructions. Repeating the same declaration answers the same 200.
Request
Responses
- 200
- 404
- 409
- 422
The instruction's settlement row, carrying the declaration.
No payment batch with this id is reachable by the token's grants, or the instruction is not one of this batch.
stale_version: the batch changed since the expected_version you sent. NOTHING WAS DECLARED; details carries the current version and batch. idempotency_key_reuse and idempotency_request_in_progress also answer 409, with no details.
validation_failed: the Idempotency-Key header is missing, or reason, note or expected_version is invalid (details names each field); operation_failed: the declaration is refused - the batch was paid through a bank consent, the instruction's execution is not to be confirmed, or another settlement action holds the batch - and message says why.