openapi: 3.0.3
info:
description: '<h2>Let''s build something great.</h2><p>Welcome to the official reference documentation for Synctera APIs. Our APIs are the best way to automate your company''s banking needs and are designed to be easy to understand and implement.</p><p>We''re continuously growing this library and what you see here is just the start, but if you need something specific or have a question, <a class=''text-blue-600'' href=''https://synctera.com/contact'' target=''_blank'' rel=''noreferrer''>contact us</a>.</p>
'
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
title: Synctera Accounts Sandbox Wipe (alpha) API
version: 0.20.0
servers:
- description: Production
url: https://api.synctera.com/v0
- description: Sandbox (no real world financial impact)
url: https://api-sandbox.synctera.com/v0
security:
- bearerAuth: []
tags:
- name: Sandbox Wipe (alpha)
paths:
/wipe:
summary: Wipe
post:
description: "Delete the customer and account related data, leaving other configuration data intact. This enables use cases such as bulk data deletion between tests.\nData associated with below resources will be deleted:\n - Accounts\n - Account applications\n - ACH\n - Businesses\n - Cards\n - Card images\n - Cases\n - Customers\n - Disclosures\n - External Accounts\n - Internal Accounts\n - Payment schedules and history\n - Persons\n - RDC\n - Relationships\n - Transactions (including for Internal Accounts)\n - Verifications\n\nData associated with below resources will be retained:\n - Account Templates\n - API Keys\n - Bank/Partner data\n - Card product\n - Disclosure document records\n - Egress config\n - Groups\n - PII contract with vault\n - Roles\n - Users\n - Webhooks\n"
operationId: wipeWorkspace
responses:
'204':
description: successfully wiped resources for a particular tenant
'404':
$ref: '#/components/responses/not_found'
'500':
$ref: '#/components/responses/internal_server_error'
summary: Delete data
tags:
- Sandbox Wipe (alpha)
x-external: true
x-status: alpha
components:
responses:
internal_server_error:
content:
application/problem+json:
schema:
$ref: '#/components/schemas/error'
description: Internal server error
not_found:
content:
application/problem+json:
schema:
$ref: '#/components/schemas/error'
description: Resource not found
schemas:
error:
properties:
detail:
description: a human-readable string explaining this particular error
example: 'missing required fields: first_name, dob'
type: string
status:
description: the HTTP status code for this response
example: 400
type: integer
title:
description: a human-readable string for this general category of error
example: Bad Request Body
type: string
type:
description: a URI that identifies this general category of error
example: https://dev.synctera.com/errors/bad-request-body
type: string
title: Standard error response (RFC 7807 problem report)
type: object
securitySchemes:
bearerAuth:
bearerFormat: api_key
scheme: bearer
type: http
x-readme:
explorer-enabled: true
proxy-enabled: true
samples-enabled: true