---
title: "Update submission with payment session final outcome"
method: PATCH
path: "/submission/{submission-id}/payment"
tags: ["payment"]
---

# Update submission with payment session final outcome

`PATCH /submission/{submission-id}/payment`

## Request

- Base URL: `/efs-submissions-api` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/efs-submissions-api/submission/{submission-id}/payment`
- Auth: none declared
- TypeScript: <https://skmtc.dev/companies-house/apis/emergency-filing-service-api/docs/submission/:submission-id/payment/patch.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- SessionOutcome
  - `status` 'Paid' | 'Pending' | 'Failed': Provisional payment session status
  - `payment_reference` string
  - `paid_at` string, date-time: paid-at timestamp

## Response `204`

No Content

## Other responses

- `400`: Incomplete or malformed request
- `401`: Invalid or missing credentials
- `404`: Requested resource was not found
- `409`: Request valid but not consistent with state of resource

## Changes

- **2021-05-13** `cdce75332102`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/companies-house/apis/emergency-filing-service-api/changes/submission/:submission-id/payment/patch.md)

---

[API](https://skmtc.dev/companies-house/apis/emergency-filing-service-api.md) - [All operations](https://skmtc.dev/companies-house/apis/emergency-filing-service-api/llms.txt) - [OpenAPI document](https://skmtc.dev/companies-house/apis/emergency-filing-service-api/revisions/7dbd2ded46b4?raw)
