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)
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.

status'Paid' | 'Pending' | 'Failed'

Provisional payment session status

payment_referencestring

paid_atstring date-time

paid-at timestamp

{
  "status": "Pending",
  "payment_reference": "yMxgdNVSdwyk7sN"
}

No Content