/
GO
government-digital-service
/
Connector API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 29m ago · Updated 22h ago
latest
OpenAPI 3.0.1
raw.githubusercontent.com
2026-08-21
93
79
198.2 KB
68dc8eefc661
Agreements
4
post
Create an agreement
post
/v1/api/accounts/{accountId}/agreements/{agreementId}/cancel
post
Create an agreement for a service ID and account type (test|live)
post
/v1/api/service/{serviceId}/account/{accountType}/agreements/{agreementId}/cancel
Charge events
2
get
Get transaction history for a charge
get
Get transaction history for a charge
Charge operations
12
post
Cancel charge
post
Mark delayed capture charge as eligible for capture and adds charge to capture queue
post
Authorise MOTO (api) payment
post
Cancel charge
post
Mark delayed capture charge as eligible for capture and adds charge to capture queue
post
Authorise 3DS charge
post
Cancel charge (action by user)
post
Mark charge as eligible for capture
post
Authorise charge
post
Authorise Apple Pay payment
post
Authorise Google Pay payment
post
Authorise Adyen Google Pay payment
Charges
7
post
Create new charge for gateway account
get
Get charge by account ID and charge external ID
post
Create a new telephone charge for gateway account.
get
Find charge by gateway transaction ID
post
Create new charge for service ID and account type
get
Get charge by service ID, account type and charge external ID
post
Create a new telephone charge by service id and account type
Charges - Frontend
4
get
Find a charge
patch
Update charge (email field only)
put
Update status of a charge
get
Get Worldpay 3DS Flex DDC JWT
Discrepancies
2
post
Compare charge status with gateway
post
Resolve charge status discrepancy
Gateway account credentials
10
post
Create or update 3DS flex credentials (worldpay accounts)
post
Create credentials for a gateway account
patch
Update a gateway account credential
post
Validate Worldpay 3DS flex credentials
post
Validate Worldpay credentials
put
Create or update 3DS flex credentials (worldpay accounts)
post
Create credentials for a gateway account by service external ID and account type (test|live)
patch
Update a gateway account credential by service ID and account Type
post
Validate Worldpay 3DS flex credentials
post
Validate Worldpay credentials by service ID and account type
Gateway accounts
30
get
Search gateway accounts
post
Create a new gateway account
get
Find gateway account by ID
patch
Patch a gateway account
patch
Enables/disables email notifications for gateway account
get
Retrieves Stripe Connect account information for a given gateway account ID
get
Retrieve Stripe connect account setup tasks for a given gateway account ID
patch
Update Stripe Connect account setup tasks have been completed for a given accountId
post
Switch payment provider of a gateway account
post
Switch payment provider of a gateway account
get
Find gateway account by service external ID and account type (test|live)
patch
Patch a gateway account
get
Retrieve Adyen account setup tasks for a given service ID, account type and credential ID
patch
Update Adyen account setup tasks for a given service ID, account type and credential ID
patch
Enables/disables email notifications for gateway account
get
Retrieves Stripe Connect account information for a given service ID and account type (test|live)
get
Retrieve Stripe connect account setup tasks for a given service ID and account type
patch
Update Stripe Connect account setup tasks have been completed for a given service ID and account type
post
Creates an Adyen Test Account and associated entities
post
1) Creates a Stripe Connect Account 2) Creates a gateway account in connector and links this with the Stripe Connect Account id 3) Disables the old sandbox account
post
Disables Stripe test account, creates an Adyen Test Account and associated entities
get
Find gateway account by gateway account external ID
patch
Set requires3ds flag on a gateway account
get
Get card types for gateway account
post
Update accepted card types for a gateway account
patch
Update service name of a gateway account
patch
Set requires3ds flag on a gateway account
get
Get card types for gateway account by service external ID and account type
post
Update accepted card types for a gateway account
patch
Update service name of Test and Live (if existent) accounts for service
Notifications
4
post
Handle Adyen payment and token notifications
post
Handle sandbox notifications
post
Handle Stripe notifications
post
Handle Worldpay notifications
Other
1
get
Healthcheck endpoint for connector (checks postgresql, cardExecutorService, ping, sqsQueue, deadlocks)
Refunds
4
post
Refund a charge
get
Get a refund
post
Refund a charge
get
Get a refund
Secure token
3
get
Retrieve secure token
delete
Delete secure token
post
Mark secure token as used
Tasks
7
post
Sweep emitted events
post
Expire charges, tokens and idempotency keys
post
Expunge charges and refunds in terminal state
post
Cleanup charges with Gateway
post
Emit events for charges or refunds
post
Emit events for charges or refunds by date
post
Parity check charges or refunds with ledger
post
Resend confirmation email for a charge
get
List all card types
post
Resend confirmation email for a charge
Other
Healthcheck endpoint for connector (checks postgresql, cardExecutorService, ping, sqsQueue, deadlocks)
get
/healthcheck
Response
OK
string
required