Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
940 changes: 940 additions & 0 deletions docs/api/README.md

Large diffs are not rendered by default.

515 changes: 515 additions & 0 deletions openapi.yaml

Large diffs are not rendered by default.

299 changes: 299 additions & 0 deletions openapi/v3/v3-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1015,6 +1015,305 @@ paths:
security:
- Authorization:
- payments:read
delete:
tags:
- payments.v3
summary: Delete a payment service user by ID
operationId: v3DeletePaymentServiceUser
x-speakeasy-name-override: DeletePaymentServiceUser
parameters:
- $ref: '#/components/parameters/V3PaymentServiceUserID'
responses:
"202":
description: Accepted
content:
application/json:
schema:
$ref: "#/components/schemas/V3PaymentServiceUserDeleteResponse"
default:
description: Error
content:
application/json:
schema:
$ref: "#/components/schemas/V3ErrorResponse"
security:
- Authorization:
- payments:write


/v3/payment-service-users/{paymentServiceUserID}/connections:
get:
tags:
- payments.v3
summary: List all connections for a payment service user
operationId: v3ListPaymentServiceUserConnections
x-speakeasy-name-override: ListPaymentServiceUserConnections
parameters:
- $ref: '#/components/parameters/V3PaymentServiceUserID'
- $ref: '#/components/parameters/V3PageSize'
- $ref: '#/components/parameters/V3Cursor'
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/V3QueryBuilder"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/V3PaymentServiceUserConnectionsCursorResponse"
default:
description: Error
content:
application/json:
schema:
$ref: "#/components/schemas/V3ErrorResponse"
security:
- Authorization:
- payments:read

/v3/payment-service-users/{paymentServiceUserID}/connectors/{connectorID}:
delete:
tags:
- payments.v3
summary: Remove a payment service user from a connector, the PSU will still exist in Formance
operationId: v3DeletePaymentServiceUserConnector
x-speakeasy-name-override: DeletePaymentServiceUserConnector
parameters:
- $ref: '#/components/parameters/V3PaymentServiceUserID'
- $ref: '#/components/parameters/V3ConnectorID'
responses:
"202":
description: Accepted
content:
application/json:
schema:
$ref: "#/components/schemas/V3PaymentServiceUserDeleteConnectorResponse"
default:
description: Error
content:
application/json:
schema:
$ref: "#/components/schemas/V3ErrorResponse"
security:
- Authorization:
- payments:write

/v3/payment-service-users/{paymentServiceUserID}/connectors/{connectorID}/forward:
post:
tags:
- payments.v3
summary: Register/forward a payment service user on/to a connector
operationId: v3ForwardPaymentServiceUserToBankBridge
x-speakeasy-name-override: ForwardPaymentServiceUserToBankBridge
parameters:
- $ref: '#/components/parameters/V3PaymentServiceUserID'
- $ref: '#/components/parameters/V3ConnectorID'
responses:
"204":
description: No Content
default:
description: Error
content:
application/json:
schema:
$ref: "#/components/schemas/V3ErrorResponse"
security:
- Authorization:
- payments:write

/v3/payment-service-users/{paymentServiceUserID}/connectors/{connectorID}/create-link:
post:
tags:
- payments.v3
summary: Create an authentication link for a payment service user on a connector, for oauth flow
operationId: v3CreateLinkForPaymentServiceUser
x-speakeasy-name-override: CreateLinkForPaymentServiceUser
parameters:
- $ref: '#/components/parameters/V3PaymentServiceUserID'
- $ref: '#/components/parameters/V3ConnectorID'
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/V3PaymentServiceUserCreateLinkRequest"
responses:
"201":
description: Created
content:
application/json:
schema:
$ref: "#/components/schemas/V3PaymentServiceUserCreateLinkResponse"
default:
description: Error
content:
application/json:
schema:
$ref: "#/components/schemas/V3ErrorResponse"
security:
- Authorization:
- payments:write

/v3/payment-service-users/{paymentServiceUserID}/connectors/{connectorID}/connections:
get:
tags:
- payments.v3
summary: List enabled connections for a payment service user on a connector (i.e. the various banks PSUser has enabled on the connector)
operationId: v3ListPaymentServiceUserConnectionsFromConnectorID
x-speakeasy-name-override: ListPaymentServiceUserConnectionsFromConnectorID
parameters:
- $ref: '#/components/parameters/V3PaymentServiceUserID'
- $ref: '#/components/parameters/V3ConnectorID'
- $ref: '#/components/parameters/V3PageSize'
- $ref: '#/components/parameters/V3Cursor'
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/V3QueryBuilder"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/V3PaymentServiceUserConnectionsCursorResponse"
default:
description: Error
content:
application/json:
schema:
$ref: "#/components/schemas/V3ErrorResponse"
security:
- Authorization:
- payments:read

/v3/payment-service-users/{paymentServiceUserID}/connectors/{connectorID}/link-attempts:
get:
tags:
- payments.v3
summary: |
List all link attempts for a payment service user on a connector.
Allows to check if users used the link and completed the oauth flow.
operationId: v3ListPaymentServiceUserLinkAttemptsFromConnectorID
x-speakeasy-name-override: ListPaymentServiceUserLinkAttemptsFromConnectorID
parameters:
- $ref: '#/components/parameters/V3PaymentServiceUserID'
- $ref: '#/components/parameters/V3ConnectorID'
- $ref: '#/components/parameters/V3PageSize'
- $ref: '#/components/parameters/V3Cursor'
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/V3QueryBuilder"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/V3PaymentServiceUserLinkAttemptsCursorResponse"
default:
description: Error
content:
application/json:
schema:
$ref: "#/components/schemas/V3ErrorResponse"
security:
- Authorization:
- payments:read

/v3/payment-service-users/{paymentServiceUserID}/connectors/{connectorID}/link-attempts/{attemptID}:
get:
tags:
- payments.v3
summary: Get a link attempt for a payment service user on a connector
operationId: v3GetPaymentServiceUserLinkAttemptFromConnectorID
x-speakeasy-name-override: GetPaymentServiceUserLinkAttemptFromConnectorID
parameters:
- $ref: '#/components/parameters/V3PaymentServiceUserID'
- $ref: '#/components/parameters/V3ConnectorID'
- $ref: '#/components/parameters/V3AttemptID'
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/V3PaymentServiceUserLinkAttempt"
default:
description: Error
content:
application/json:
schema:
$ref: "#/components/schemas/V3ErrorResponse"
security:
- Authorization:
- payments:read

/v3/payment-service-users/{paymentServiceUserID}/connectors/{connectorID}/connections/{connectionID}:
delete:
tags:
- payments.v3
summary: Delete a connection for a payment service user on a connector
operationId: v3DeletePaymentServiceUserConnectionFromConnectorID
x-speakeasy-name-override: DeletePaymentServiceUserConnectionFromConnectorID
parameters:
- $ref: '#/components/parameters/V3PaymentServiceUserID'
- $ref: '#/components/parameters/V3ConnectorID'
- $ref: '#/components/parameters/V3ConnectionID'
responses:
"202 ":
description: Accepted
content:
application/json:
schema:
$ref: "#/components/schemas/V3PaymentServiceUserDeleteConnectionResponse"
default:
description: Error
content:
application/json:
schema:
$ref: "#/components/schemas/V3ErrorResponse"
security:
- Authorization:
- payments:write

/v3/payment-service-users/{paymentServiceUserID}/connectors/{connectorID}/connections/{connectionID}/update-link:
post:
tags:
- payments.v3
summary: Update/Regenerate a link for a payment service user on a connector
operationId: v3UpdateLinkForPaymentServiceUserOnConnector
x-speakeasy-name-override: UpdateLinkForPaymentServiceUserOnConnector
parameters:
- $ref: '#/components/parameters/V3PaymentServiceUserID'
- $ref: '#/components/parameters/V3ConnectorID'
- $ref: '#/components/parameters/V3ConnectionID'
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/V3PaymentServiceUserUpdateLinkRequest"
responses:
"201":
description: Created
content:
application/json:
schema:
$ref: "#/components/schemas/V3PaymentServiceUserUpdateLinkResponse"
default:
description: Error
content:
application/json:
schema:
$ref: "#/components/schemas/V3ErrorResponse"
security:
- Authorization:
- payments:write

/v3/payment-service-users/{paymentServiceUserID}/bank-accounts/{bankAccountID}:
post:
Expand Down
16 changes: 16 additions & 0 deletions openapi/v3/v3-parameters.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,22 @@ components:
schema:
type: string

V3AttemptID:
name: attemptID
in: path
required: true
description: The attempt ID
schema:
type: string

V3ConnectionID:
name: connectionID
in: path
required: true
description: The connection ID
schema:
type: string

V3PaymentID:
name: paymentID
in: path
Expand Down
Loading
Loading