payment

Add/update payment session(s) details

Changed on Oct 16, 2020

put/submission/{submission-id}/payment-sessions

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-sessions/put.ts
A function with typed inputs. Its response is checked against the schema.

Response

Session details updated

session_idstring required

session_statestring Base64 encoded required

secure random nonce

session_status'Paid' | 'Pending' | 'Failed' required

Provisional payment session status

Example response

[
  {
    "session_id": "yMxgdNVSdwyk7sN",
    "session_state": "FD_RlzcLp-xcK1YZGEbn3ZpRHGlwy7tNjn_zsjYVauoB8Ml3GkfpmbhPuPd093XM",
    "session_status": "Pending"
  }
]

Changes

Oct 16, 202023e5c1f1c8a2 Revision changes
- info
  endpoint added

Operation history

Add/update payment session(s) details

Request

Response 201Created

Example response

Changes

Response