openapi: 3.0.2 info: title: Unit OpenAPI specifications description: An OpenAPI specifications for unit-sdk clients version: 0.0.2 x-konfig-ignore: object-with-no-properties: true servers: - url: https://api.s.unit.sh tags: - name: StopPayment - name: Get Application - name: Update Application - name: Cancel Application - name: Get List Applications - name: Create Application - name: Get List Application Forms - name: Create ApplicationForm - name: Upload a PNG Document for an Application - name: Upload a JPEG Document for an Application - name: Upload a PNG Document for an Application - Back Side - name: Upload a JPEG Document for an Application - Back Side - name: Get List of Documents - name: Create a Document for an Application - name: Verify a Document for an Application - name: Download a Document - name: Download a Document - Back Side - name: Get Application Form - name: Get List Accounts - name: Create Account - name: Get Account - name: Update Account - name: Get Account Limits - name: Unfreeze Account - name: Freeze an Account - name: Close an Account - name: Reopen an Account - name: Enter Control Agreement for Account - name: Activate Control Agreement for Account - name: Deactivate Control Agreement for Account - name: Get list account end-of-day balances history - name: Get Customer - name: Update Customer - name: Get List Customers - name: Archive Customer - name: Get List Payments - name: Create a Payment - name: Get Payment - name: Update Payment - name: Cancel Payment - name: Get Received Payments List - name: Get Received Payment - name: Update Received Payment - name: Advance Received Payment - name: Get List Counterparties - name: Create Counterparty - name: Delete Counterparty - name: Get Counterparty - name: Update Counterparty - name: Get Counterparty Balance - name: Get List Recurring Payments - name: Create Recurring Payment - name: Get Recurring Payment - name: Disable Recurring Payment - name: Enable Recurring Payment - name: Get List of Cards - name: Create a Card - name: Get Card - name: Update Card - name: Get Card PIN Status - name: Report Card as Stolen - name: Report Card as Lost - name: Close a Card - name: Freeze a Card - name: Unfreeze a Card - name: Get Card Limits - name: Get List Authorizations - name: Get Authorization - name: Get List Authorization Requests - name: Get Authorization Request - name: Approve Authorization Request - name: Decline Authorization Request - name: Get List Statements - name: Get Statement HTML - name: Get Statement PDF - name: Get Bank verification PDF - name: Get List Rewards - name: Create Reward - name: Get Reward - name: Get List Events - name: Get Event - name: Fire Event - name: Get Institution - name: Create Fee - name: Get List Check Deposits - name: Create Check Deposit - name: Get Check Deposit - name: Update Check Deposit - name: Confirm Check Deposit - name: Get Check Deposit Front Image - name: Get Check Deposit Back Image - name: Get List Org API Tokens - name: Create Org Api Token - name: Revoke Org API Token - name: Create Customer Token - name: Create Customer Token Verification - name: Get List Webhooks - name: Create Webhook - name: Get Webhook - name: Update Webhook - name: Enable Webhook - name: Disable Webhook - name: Get ATM Locations List - name: Get Transaction - name: Update Transaction - name: Get List Transactions - name: Get List Disputes - name: Get Dispute - name: Get List Repayments - name: Create a Repayment - name: Get Repayment - name: Get List Check Payments - name: Create Check Payment - name: Get Check Payment - name: Approve Check Payment - name: Cancel Check Payment - name: Return Check Payment - name: Get a front image - name: Get a back image - name: Upload a PDF Document for an Application - name: Upload a PDF Document for an Application - Back Side paths: /applications/{applicationId}: get: tags: - Get Application summary: Get Application by Id operationId: GetApplication_byId description: 'Get an Application from API ' parameters: - description: ID of the application to get schema: type: string name: applicationId in: path required: true - name: included in: query schema: type: string responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetApplicationByIdResponse' patch: tags: - Update Application summary: Update Application operationId: UpdateApplication_viaApi description: 'Update an Application via API ' parameters: - description: ID of the application to update schema: type: string name: applicationId in: path required: true requestBody: description: Update Application Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/UpdateApplicationViaApiRequest' responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema /applications/{applicationId}/cancel: post: tags: - Cancel Application summary: Cancel Application by Id operationId: CancelApplication_byId description: 'Cancel a Application via API ' parameters: - description: ID of the application to get schema: type: string name: applicationId in: path required: true requestBody: description: Cancel Application Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/CancelApplicationByIdRequest' responses: '201': description: Successful Response content: application/vnd.api+json: schema: $ref: '#/components/schemas/CancelApplicationByIdResponse' /applications: get: tags: - Get List Applications summary: Get List Application operationId: GetListApplications_fromApi description: 'Get List Applications from API ' parameters: - name: page in: query schema: $ref: '#/paths/~1cards/get/parameters/0/schema' - name: filter in: query style: deepObject allowReserved: true schema: type: object properties: tags: type: object additionalProperties: type: string query: type: string status: type: array items: type: string enum: - AwaitingDocuments - PendingReview - Pending - Approved - Denied - Canceled email: type: string - name: sort in: query schema: type: string responses: '200': description: Successful Response content: application/vnd.api+json: schema: $ref: '#/components/schemas/GetListApplicationsFromApi200Response' default: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/GetListApplicationsFromApiResponse' post: tags: - Create Application summary: Create Application operationId: CreateApplication_viaApi description: 'Create an Application via API ' requestBody: title: CreateApplicationRequest description: Create Application Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/CreateApplicationViaApiRequest' responses: '201': description: Successful Response content: application/vnd.api+json: schema: $ref: '#/components/schemas/CreateApplicationViaApiResponse' /application-forms: get: tags: - Get List Application Forms summary: Get List Application Forms operationId: GetListApplicationForms_viaApi description: 'Get List Application Forms from API ' parameters: - name: page in: query schema: $ref: '#/paths/~1cards/get/parameters/0/schema' - name: filter in: query style: deepObject allowReserved: true schema: type: object properties: tags: type: object additionalProperties: type: string query: type: string status: type: array items: type: string enum: - Pending - Approved email: type: string - name: sort in: query schema: type: string responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetListApplicationFormsViaApiResponse' post: tags: - Create ApplicationForm summary: Create Application Form operationId: CreateApplicationForm_viaApi description: 'Create an Application Form via API ' requestBody: description: Create Application Form Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/CreateApplicationFormViaApiRequest' responses: '201': description: Successful Response content: application/vnd.api+json: schema: $ref: '#/components/schemas/CreateApplicationFormViaApiResponse' /applications/{applicationId}/documents/{documentId}: put: tags: - Upload a PNG Document for an Application summary: Upload a PNG document operationId: UploadAPngDocumentForAnApplication_byId description: 'Upload a PNG file via API ' parameters: - description: ID of the application to upload a file to schema: type: string name: applicationId in: path required: true - description: ID of the document to upload a file for schema: type: string name: documentId in: path required: true requestBody: description: Upload PNG File required: true content: image/png: schema: $ref: >- #/components/schemas/UploadAPngDocumentForAnApplicationByIdRequest responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/paths/~1applications~1%7BapplicationId%7D~1documents/post/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema /applications/{applicationId}/documents/{documentId}/?: put: tags: - Upload a JPEG Document for an Application summary: Upload a JPEG document operationId: UploadAJpegDocumentForAnApplication_viaApi description: 'Upload a JPEG file via API ' parameters: - description: ID of the application to upload a file to schema: type: string name: applicationId in: path required: true - description: ID of the document to upload a file for schema: type: string name: documentId in: path required: true requestBody: description: Upload JPEG File required: true content: image/jpeg: schema: $ref: >- #/components/schemas/UploadAJpegDocumentForAnApplicationViaApiRequest responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/paths/~1applications~1%7BapplicationId%7D~1documents/post/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema /applications/{applicationId}/documents/{documentId}/back: put: tags: - Upload a PNG Document for an Application - Back Side summary: Upload a PNG document - Back Side operationId: UploadAPngDocumentForAnApplicationBackSide_put description: Upload a PNG file via API - Back Side parameters: - description: ID of the application to upload a file to schema: type: string name: applicationId in: path required: true - description: ID of the document to upload a file for schema: type: string name: documentId in: path required: true requestBody: description: Upload PNG File - Back Side required: true content: image/png: schema: $ref: >- #/components/schemas/UploadAPngDocumentForAnApplicationBackSidePutRequest responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/paths/~1applications~1%7BapplicationId%7D~1documents/post/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema /applications/{applicationId}/documents/{documentId}/back/?: put: tags: - Upload a JPEG Document for an Application - Back Side summary: Upload a JPEG document - Back Side operationId: UploadAJpegDocumentForAnApplicationBackSide_put description: Upload a JPEG file via API - Back Side parameters: - description: ID of the application to upload a file to schema: type: string name: applicationId in: path required: true - description: ID of the document to upload a file for schema: type: string name: documentId in: path required: true requestBody: description: Upload JPEG File - Back Side required: true content: image/jpeg: schema: $ref: >- #/components/schemas/UploadAJpegDocumentForAnApplicationBackSidePutRequest responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/paths/~1applications~1%7BapplicationId%7D~1documents/post/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema /applications/{applicationId}/documents: get: tags: - Get List of Documents summary: Get List of Documents operationId: GetListOfDocuments_viaApi description: 'Get List of Documents via API ' parameters: - description: ID of the application to get documents for schema: type: string name: applicationId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetListOfDocumentsViaApiResponse' post: tags: - Create a Document for an Application summary: Create a document operationId: CreateADocumentForAnApplication_viaApi description: 'Create a document via API ' parameters: - description: ID of the application to create a file for schema: type: string name: applicationId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/components/schemas/CreateADocumentForAnApplicationViaApiResponse /applications/{applicationId}/documents/{documentId}/verify: put: tags: - Verify a Document for an Application summary: Verify a document operationId: VerifyADocumentForAnApplication_put description: 'Verify a document via API ' parameters: - description: ID of the application to verify a file for schema: type: string name: applicationId in: path required: true - description: ID of the document to verify schema: type: string name: documentId in: path required: true requestBody: description: Verify Document required: true content: application/json: schema: $ref: '#/components/schemas/VerifyADocumentForAnApplicationPutRequest' responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/paths/~1applications~1%7BapplicationId%7D~1documents/post/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema /applications/{applicationId}/documents/{documentId}/download: get: tags: - Download a Document summary: Download a Document operationId: DownloadADocument_viaApi description: 'Download a Document via API ' parameters: - description: ID of the application schema: type: string name: applicationId in: path required: true - description: ID of the document to download schema: type: string name: documentId in: path required: true responses: '200': description: Successful Response content: application/octet-stream: schema: $ref: '#/components/schemas/DownloadADocumentViaApiResponse' /applications/{applicationId}/documents/{documentId}/download/back: get: tags: - Download a Document - Back Side summary: Download a Document - Back Side operationId: DownloadADocumentBackSide_viaApi description: Download a Document - Back Side via API parameters: - description: ID of the application schema: type: string name: applicationId in: path required: true - description: ID of the document to download schema: type: string name: documentId in: path required: true responses: '200': description: Successful Response content: application/octet-stream: schema: $ref: '#/components/schemas/DownloadADocumentBackSideViaApiResponse' /application-forms/{applicationFormId}: get: tags: - Get Application Form summary: Get ApplicationForm by Id operationId: GetApplicationForm_byId description: 'Get an Application Form from API ' parameters: - description: ID of the application form to get schema: type: string name: applicationFormId in: path required: true - name: included in: query schema: type: string responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetApplicationFormByIdResponse' /accounts: get: tags: - Get List Accounts summary: Get List Accounts operationId: GetListAccounts_fromApi description: 'Get List Accounts from API ' parameters: - name: page in: query schema: $ref: '#/paths/~1cards/get/parameters/0/schema' - name: filter in: query style: deepObject allowReserved: true schema: type: object properties: tags: type: object additionalProperties: type: string customerId: type: string status: type: array items: type: string enum: - Open - Frozen - Closed type: type: array items: type: string enum: - deposit - credit fromBalance: type: number toBalance: type: number - name: include in: query schema: type: string responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetListAccountsFromApiResponse' '401': description: UnitError type: array items: type: object properties: title: type: string status: type: string code: type: string detail: type: string details: type: string source: type: object properties: pointer: type: string meta: type: object post: tags: - Create Account summary: Create Account operationId: CreateAccount_viaApi description: 'Create Account via API ' requestBody: title: CreateAccountRequest description: Create Account Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/CreateAccountViaApiRequest' responses: '201': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/paths/~1accounts~1%7BaccountId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema default: $ref: '#/paths/~1accounts/get/responses/401' /accounts/{accountId}: get: tags: - Get Account summary: Get Account by Id operationId: GetAccount_byId description: 'Get an Account from API ' parameters: - description: ID of the account to get schema: type: string name: accountId in: path required: true - name: include in: query schema: type: string responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetAccountByIdResponse' patch: tags: - Update Account summary: Update Account operationId: UpdateAccount_viaApi description: 'Update an Account via API ' parameters: - description: ID of the account to update schema: type: string name: accountId in: path required: true requestBody: title: UpdateAccountRequest description: Update Account Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/UpdateAccountViaApiRequest' responses: '200': description: Successful Response content: application/vnd.api+json: schema: $ref: '#/components/schemas/UpdateAccountViaApiResponse' default: $ref: '#/paths/~1accounts/get/responses/401' /accounts/{accountId}/limits: get: tags: - Get Account Limits summary: Get Account Limits by Id operationId: GetAccountLimits_byId description: 'Get Account Limits from API ' parameters: - description: ID of the account to get schema: type: string name: accountId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetAccountLimitsByIdResponse' /accounts/{accountId}/unfreeze: post: tags: - Unfreeze Account summary: Unfreeze Account by Id operationId: UnfreezeAccount_byId description: 'Unfreeze an Account via API ' parameters: - description: ID of the account to get schema: type: string name: accountId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/paths/~1accounts~1%7BaccountId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema default: $ref: '#/paths/~1accounts/get/responses/401' /accounts/{accountId}/freeze: post: tags: - Freeze an Account summary: Freeze Account by Id operationId: FreezeAnAccount_byId description: 'Freeze Account via API ' parameters: - description: ID of the account to freeze schema: type: string name: accountId in: path required: true requestBody: title: FreezeAccountRequest description: Freeze Account Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/FreezeAnAccountByIdRequest' responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/paths/~1accounts~1%7BaccountId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema default: $ref: '#/paths/~1accounts/get/responses/401' /accounts/{accountId}/close: post: tags: - Close an Account summary: Close an Account by Id operationId: CloseAnAccount_byId description: 'Close an Account via API ' parameters: - description: ID of the account to close schema: type: string name: accountId in: path required: true requestBody: title: CloseAccountRequest description: Close Account Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/CloseAnAccountByIdRequest' responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/paths/~1accounts~1%7BaccountId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema default: $ref: '#/paths/~1accounts/get/responses/401' /accounts/{accountId}/reopen: post: tags: - Reopen an Account summary: Reopen an Account by Id operationId: ReopenAnAccount_byId description: 'Reopen an Account via API ' parameters: - description: ID of the account to close schema: type: string name: accountId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/paths/~1accounts~1%7BaccountId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema default: $ref: '#/paths/~1accounts/get/responses/401' /accounts/{accountId}/enter-daca: post: tags: - Enter Control Agreement for Account summary: Enter Account Control Agreement by Id operationId: EnterControlAgreementForAccount_byId description: 'Enter Control Agreement for Account via API ' parameters: - description: ID of the account schema: type: string name: accountId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/paths/~1accounts~1%7BaccountId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema default: $ref: '#/paths/~1accounts/get/responses/401' /accounts/{accountId}/activate-daca: post: tags: - Activate Control Agreement for Account summary: Activate Account Control Agreement by Id operationId: ActivateControlAgreementForAccount_byId description: 'Activate Control Agreement for Account via API ' parameters: - description: ID of the account schema: type: string name: accountId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/paths/~1accounts~1%7BaccountId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema default: $ref: '#/paths/~1accounts/get/responses/401' /accounts/{accountId}/deactivate-daca: post: tags: - Deactivate Control Agreement for Account summary: Deactivate Account Control Agreement by Id operationId: DeactivateControlAgreementForAccount_byId description: Deactivate Control Agreement for Account via API parameters: - description: ID of the account schema: type: string name: accountId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/paths/~1accounts~1%7BaccountId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema '404': $ref: '#/paths/~1accounts/get/responses/401' /account-end-of-day: get: tags: - Get list account end-of-day balances history summary: Get AccountEndOfDay List operationId: GetListAccountEndofdayBalancesHistory_fromApi description: 'Get AccountEndOfDay List from API ' responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/components/schemas/GetListAccountEndofdayBalancesHistoryFromApiResponse default: $ref: '#/paths/~1accounts/get/responses/401' /customers/{customerId}: get: tags: - Get Customer summary: Get Customer by Id operationId: GetCustomer_byId description: 'Get a Customer from API ' parameters: - description: ID of the customer to get schema: type: string name: customerId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/paths/~1customers~1%7BcustomerId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema patch: tags: - Update Customer summary: Update Customer operationId: UpdateCustomer_viaApi description: 'Update an Customer via API ' parameters: - description: ID of the customer to update schema: type: string name: customerId in: path required: true requestBody: description: Update Customer Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/UpdateCustomerViaApiRequest' responses: '200': description: Successful Response content: application/vnd.api+json: schema: $ref: '#/components/schemas/UpdateCustomerViaApiResponse' /customers: get: tags: - Get List Customers summary: Get Customers List operationId: GetListCustomers_apiList description: 'Get Customers List from API ' parameters: - name: page in: query schema: $ref: '#/paths/~1cards/get/parameters/0/schema' - name: filter in: query style: deepObject allowReserved: true schema: type: object properties: tags: type: object additionalProperties: type: string query: type: string status: type: array items: type: string enum: - Active - Archived email: type: string - name: sort in: query schema: type: string responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetListCustomersApiListResponse' /customers/{customerId}/archive: post: tags: - Archive Customer summary: Archive Customer by Id operationId: ArchiveCustomer_byId description: 'Archive a Customer via API ' parameters: - description: ID of the customer to archive schema: type: string name: customerId in: path required: true requestBody: description: Archive Customer Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/ArchiveCustomerByIdRequest' responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/paths/~1customers~1%7BcustomerId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema /payments: get: tags: - Get List Payments summary: Get List Payments operationId: GetListPayments_fromApi description: 'Get List Payments from API ' parameters: - name: page in: query schema: $ref: '#/paths/~1cards/get/parameters/0/schema' - name: filter in: query style: deepObject allowReserved: true schema: type: object properties: tags: type: object additionalProperties: type: string accountId: type: string customerId: type: string counterpartyAccountId: type: string status: type: array items: type: string enum: - Rejected - Pending - Canceled - Pending Review - Clearing - Sent - Returned type: type: array items: type: string enum: - AchPayment - BookPayment - WirePayment direction: type: array items: type: string enum: - Debit - Credit since: type: string until: type: string fromAmount: type: integer toAmount: type: integer recurringPaymentId: type: integer feature: type: array items: type: string enum: - SameDay - RecurringPayment - name: include in: query schema: type: string - name: sort in: query schema: type: string responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetListPaymentsFromApiResponse' post: tags: - Create a Payment summary: Create a Payment operationId: CreateAPayment_viaApi description: 'Create a Payment via API ' requestBody: description: Create Payment Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/CreateAPaymentViaApiRequest' responses: '201': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/paths/~1payments~1%7BpaymentId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema /payments/{paymentId}: get: tags: - Get Payment summary: Get Payment by Id operationId: GetPayment_byId description: 'Get a Payment from API ' parameters: - description: ID of the payment to get schema: type: string name: paymentId in: path required: true - name: included in: query schema: type: string responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetPaymentByIdResponse' patch: tags: - Update Payment summary: Update Payment operationId: UpdatePayment_viaApi description: 'Update an Payment via API ' parameters: - description: ID of the payment to update schema: type: string name: paymentId in: path required: true requestBody: description: Update Payment Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/UpdatePaymentViaApiRequest' responses: '200': description: Successful Response content: application/vnd.api+json: schema: $ref: '#/components/schemas/UpdatePaymentViaApiResponse' /payments/{paymentId}/cancel: post: tags: - Cancel Payment summary: Cancel a Payment by Id operationId: CancelPayment_byId description: 'Cancel a Payment via API ' parameters: - description: ID of the payment to cancel schema: type: string name: paymentId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/paths/~1payments~1%7BpaymentId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema /received-payments: get: tags: - Get Received Payments List summary: Get Received Payments List operationId: GetReceivedPaymentsList_fromApi description: 'Get Received Payments from API ' parameters: - name: included in: query schema: type: string responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetReceivedPaymentsListFromApiResponse' /received-payments/{paymentId}: get: tags: - Get Received Payment summary: Get Received Payment by Id operationId: GetReceivedPayment_byId description: 'Get a Received Payment from API ' parameters: - description: ID of the payment to get schema: type: string name: paymentId in: path required: true - name: included in: query schema: type: string responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetReceivedPaymentByIdResponse' patch: tags: - Update Received Payment summary: Update Received Payment operationId: UpdateReceivedPayment_viaApi description: 'Update a Received Payment via API ' parameters: - description: ID of the payment to update schema: type: string name: paymentId in: path required: true requestBody: description: Update Received Payment Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/UpdateReceivedPaymentViaApiRequest' responses: '200': description: Successful Response content: application/vnd.api+json: schema: $ref: '#/components/schemas/UpdateReceivedPaymentViaApiResponse' /received-payments/{paymentId}/advance: post: tags: - Advance Received Payment summary: Advance Received Payment by Id operationId: AdvanceReceivedPayment_byId description: 'Advance a Received Payment via API ' parameters: - description: ID of the payment to advance schema: type: string name: paymentId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/paths/~1received-payments~1%7BpaymentId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema /counterparties: get: tags: - Get List Counterparties summary: Get Counterparties List operationId: GetListCounterparties_fromApi description: 'Get Counterparties List from API ' parameters: - name: page in: query schema: $ref: '#/paths/~1cards/get/parameters/0/schema' - name: filter in: query style: deepObject allowReserved: true schema: type: object properties: tags: type: object additionalProperties: type: string customerId: type: string accountNumber: type: string routingNumber: type: string permissions: type: array items: type: string enum: - CreditOnly - DebitOnly - CreditAndDebit - name: sort in: query schema: type: string responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetListCounterpartiesFromApiResponse' post: tags: - Create Counterparty summary: Create Counterparty operationId: CreateCounterparty_viaApi description: 'Create a counterparty via API ' requestBody: description: Create Counterparty Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/CreateCounterpartyViaApiRequest' responses: '201': description: Successful Response content: application/vnd.api+json: schema: $ref: '#/components/schemas/CreateCounterpartyViaApiResponse' /counterparties/{counterpartyId}: get: tags: - Get Counterparty summary: Get Counterparty by Id operationId: GetCounterparty_byId description: 'Get a Counterparty from API ' parameters: - description: ID of the counterparty to get schema: type: string name: counterpartyId in: path required: true - name: included in: query schema: type: string responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetCounterpartyByIdResponse' patch: tags: - Update Counterparty summary: Update Counterparty operationId: UpdateCounterparty_viaApi description: 'Update a Counterparty via API ' parameters: - description: ID of the counterparty to update schema: type: string name: counterpartyId in: path required: true requestBody: description: Update Counterparty Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/UpdateCounterpartyViaApiRequest' responses: '200': description: Successful Response content: application/vnd.api+json: schema: $ref: '#/components/schemas/UpdateCounterpartyViaApiResponse' delete: tags: - Delete Counterparty summary: Delete Counterparty by Id operationId: DeleteCounterparty_byId description: 'Delete Counterparty via API ' parameters: - description: ID of the counterparty to delete schema: type: string name: counterpartyId in: path required: true responses: '204': description: Successful Response /counterparties/{counterpartyId}/balance: get: tags: - Get Counterparty Balance summary: Get Counterparty Balance operationId: GetCounterpartyBalance_recurringPaymentFromApi description: 'Get Recurring Payment from API ' parameters: - description: ID of the counterparty to get schema: type: string name: counterpartyId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/components/schemas/GetCounterpartyBalanceRecurringPaymentFromApiResponse /recurring-payments: get: tags: - Get List Recurring Payments summary: Get Recurring Payments List operationId: GetListRecurringPayments_fromApi description: 'Get Recurring Payments List from API ' parameters: - name: page in: query schema: $ref: '#/paths/~1cards/get/parameters/0/schema' - name: filter in: query style: deepObject allowReserved: true schema: type: object properties: accountId: type: string customerId: type: string status: type: array items: type: string type: type: array items: type: string enum: - recurringCreditAchPayment - recurringDebitAchPayment - recurringCreditBookPayment fromStartTime: type: string toStartTime: type: string fromEndTime: type: string toEndTime: type: string - name: sort in: query schema: type: string responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetListRecurringPaymentsFromApiResponse' post: tags: - Create Recurring Payment summary: Create Recurring Payment operationId: CreateRecurringPayment_viaApi description: 'Create a Recurring Payment via API ' requestBody: description: Create Recurring Payment Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/CreateRecurringPaymentViaApiRequest' responses: '201': description: Successful Response content: application/vnd.api+json: schema: $ref: '#/components/schemas/CreateRecurringPaymentViaApiResponse' /recurring-payments/{paymentId}: get: tags: - Get Recurring Payment summary: Get Recurring Payment operationId: GetRecurringPayment_byId description: 'Get Recurring Payment from API ' parameters: - description: ID of the payment to get schema: type: string name: paymentId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/paths/~1recurring-payments/post/responses/201/content/application~1vnd.api%2Bjson/schema /recurring-payments/{paymentId}/disable: post: tags: - Disable Recurring Payment summary: Disable Recurring Payment operationId: DisableRecurringPayment_viaApi description: 'Disable Recurring Payment via API ' parameters: - description: ID of the payment to disable schema: type: string name: paymentId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/paths/~1recurring-payments/post/responses/201/content/application~1vnd.api%2Bjson/schema /recurring-payments/{paymentId}/enable: post: tags: - Enable Recurring Payment summary: Enable Recurring Payment operationId: EnableRecurringPayment_viaApi description: 'Enable Recurring Payment via API ' parameters: - description: ID of the payment to enable schema: type: string name: paymentId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/paths/~1recurring-payments/post/responses/201/content/application~1vnd.api%2Bjson/schema /cards: get: tags: - Get List of Cards summary: Get List of Cards operationId: GetListOfCards_fromApi description: 'Get List of Cards from API ' parameters: - name: page in: query schema: type: object properties: limit: type: integer default: 100 maximum: 1000 offset: type: integer default: 0 - name: filter style: deepObject allowReserved: true in: query schema: type: object properties: tags: type: object additionalProperties: type: string status: type: array items: type: string enum: - Inactive - Active - Stolen - Lost - Frozen - ClosedByCustomer - SuspectedFraud accountId: type: string customerId: type: string - name: include in: query schema: type: string - name: sort in: query schema: type: string responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetListOfCardsFromApiResponse' post: tags: - Create a Card summary: Create a Card operationId: CreateACard_viaApi description: 'Create a Card via API ' requestBody: description: Create Card Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/CreateACardViaApiRequest' responses: '201': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/CreateACardViaApiResponse' /cards/{cardId}: get: tags: - Get Card summary: Get Card by Id operationId: GetCard_byId description: 'Get a Card from API ' parameters: - description: ID of the card to get schema: type: string name: cardId in: path required: true - name: included in: query schema: type: string responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetCardByIdResponse' patch: tags: - Update Card summary: Update Card operationId: UpdateCard_viaApi description: 'Update a Card via API ' parameters: - description: ID of the card to update schema: type: string name: cardId in: path required: true requestBody: description: Update Card Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/UpdateCardViaApiRequest' responses: '200': description: Successful Response content: application/vnd.api+json: schema: $ref: '#/components/schemas/UpdateCardViaApiResponse' /cards/{cardId}/secure-data/pin/status: get: tags: - Get Card PIN Status summary: Get Card PIN Status operationId: GetCardPinStatus_pinStatus description: 'Get Card PIN Status via API ' parameters: - description: ID of the card to get PIN status schema: type: string name: cardId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetCardPinStatusPinStatusResponse' /cards/{cardId}/report-stolen: post: tags: - Report Card as Stolen summary: Report card as stolen operationId: ReportCardAsStolen_viaApi description: 'Report card as stolen via API ' parameters: - description: ID of the card schema: type: string name: cardId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/ReportCardAsStolenViaApiResponse' /cards/{cardId}/report-lost: post: tags: - Report Card as Lost summary: Report lost as stolen operationId: ReportCardAsLost_viaApi description: 'Report lost as stolen via API ' parameters: - description: ID of the card schema: type: string name: cardId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/ReportCardAsLostViaApiResponse' /cards/{cardId}/close: post: tags: - Close a Card summary: Close a Card operationId: CloseACard_viaApi description: 'Close a Card via API ' parameters: - description: ID of the card to close schema: type: string name: cardId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/CloseACardViaApiResponse' /cards/{cardId}/freeze: post: tags: - Freeze a Card summary: Freeze a Card operationId: FreezeACard_viaApi description: 'Freeze a Card via API ' parameters: - description: ID of the card to freeze schema: type: string name: cardId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/FreezeACardViaApiResponse' /cards/{cardId}/unfreeze: post: tags: - Unfreeze a Card summary: Unfreeze a Card operationId: UnfreezeACard_byId description: 'Unfreeze a Card via API ' parameters: - description: ID of the card to unfreeze schema: type: string name: cardId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/UnfreezeACardByIdResponse' /cards/{cardId}/limits: get: tags: - Get Card Limits summary: Get Card Limit by Id operationId: GetCardLimits_byId description: 'Get a Card Limits from API ' parameters: - description: ID of the card to get schema: type: string name: cardId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetCardLimitsByIdResponse' /authorizations: get: tags: - Get List Authorizations summary: Get List authorizations operationId: GetListAuthorizations_fromApi description: 'Get List Authorizations from API ' parameters: - name: page in: query schema: $ref: '#/paths/~1cards/get/parameters/0/schema' - name: filter in: query style: deepObject allowReserved: true schema: type: object properties: accountId: type: string accountType: type: string customerId: type: string cardId: type: string includeNonAuthorized: type: boolean merchantCategoryCode: type: array items: type: string since: type: string until: type: string fromAmount: type: integer toAmount: type: integer status: type: array items: type: string enum: - Authorized - Completed - Canceled - Declined - name: sort in: query schema: type: string responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetListAuthorizationsFromApiResponse' /authorizations/{authorizationId}: get: tags: - Get Authorization summary: Get Authorization by Id operationId: GetAuthorization_byId description: 'Get a Authorization from API ' parameters: - description: ID of the authorization to get schema: type: string name: authorizationId in: path required: true - name: includeNoneAuthorized in: query schema: type: boolean responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetAuthorizationByIdResponse' /authorization-requests: get: tags: - Get List Authorization Requests summary: Get List Authorization Requests operationId: GetListAuthorizationRequests_fromApi description: 'Get List Authorization Requests from API ' parameters: - name: page in: query schema: $ref: '#/paths/~1cards/get/parameters/0/schema' - name: filter in: query style: deepObject allowReserved: true schema: type: object properties: accountId: type: string customerId: type: string merchantCategoryCode: type: array items: type: string fromAmount: type: integer toAmount: type: integer responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/components/schemas/GetListAuthorizationRequestsFromApiResponse /authorization-requests/{authorizationId}: get: tags: - Get Authorization Request summary: Get Authorization Request by Id operationId: GetAuthorizationRequest_byId description: 'Get a Authorization Request from API ' parameters: - description: ID of the authorization request to get schema: type: string name: authorizationId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetAuthorizationRequestByIdResponse' /authorization-requests/{authorizationId}/approve: post: tags: - Approve Authorization Request summary: Approve Authorization Request by Id operationId: ApproveAuthorizationRequest_byId description: 'Approve a Authorization Request via API ' parameters: - description: ID of the authorization request to approve schema: type: string name: authorizationId in: path required: true requestBody: description: Approve Authorization Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApproveAuthorizationRequestByIdRequest' responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/ApproveAuthorizationRequestByIdResponse' /authorization-requests/{authorizationId}/decline: post: tags: - Decline Authorization Request summary: Decline Authorization Request operationId: DeclineAuthorizationRequest_viaApi description: 'Decline Authorization Request via API ' parameters: - description: ID of the authorization request to decline schema: type: string name: authorizationId in: path required: true requestBody: description: Decline Authorization Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/DeclineAuthorizationRequestViaApiRequest' responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/DeclineAuthorizationRequestViaApiResponse' /statements: get: tags: - Get List Statements summary: Get List Statements operationId: GetListStatements_fromApi description: 'Get List Statements from API ' parameters: - name: page in: query schema: $ref: '#/paths/~1cards/get/parameters/0/schema' - name: filter in: query style: deepObject allowReserved: true schema: type: object properties: accountId: type: string customerId: type: string period: type: string - name: sort in: query schema: type: string responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetListStatementsFromApiResponse' /statements/{statementId}/html: get: tags: - Get Statement HTML summary: Get HTML Statement by Id operationId: GetStatementHtml_byId description: 'Get a HTML Statement from API ' parameters: - description: ID of the statement to get schema: type: string name: statementId in: path required: true responses: '200': description: Successful Response content: text/html: schema: $ref: '#/components/schemas/GetStatementHtmlByIdResponse' /statements/{statementId}/pdf: get: tags: - Get Statement PDF summary: Get PDF Statement by Id operationId: GetStatementPdf_byId description: 'Get a PDF Statement from API ' parameters: - description: ID of the statement to get schema: type: string name: statementId in: path required: true responses: '200': description: Successful Response content: application/pdf: schema: $ref: '#/components/schemas/GetStatementPdfByIdResponse' /statements/{accountId}/bank/pdf: get: tags: - Get Bank verification PDF summary: Get Bank verification PDF operationId: GetBankVerificationPdf_fromApi description: 'Get Get Bank verification PDF from API ' parameters: - description: ID of the account to get schema: type: string name: accountId in: path required: true responses: '200': description: Successful Response content: application/pdf: schema: $ref: '#/components/schemas/GetBankVerificationPdfFromApiResponse' /rewards: post: tags: - Create Reward summary: Create Reward operationId: CreateReward_viaApi description: 'Create a Reward via API ' requestBody: description: Create Reward Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/CreateRewardViaApiRequest' responses: '201': description: Successful Response content: application/vnd.api+json: schema: $ref: '#/components/schemas/CreateRewardViaApiResponse' get: tags: - Get List Rewards summary: Get Rewards List operationId: GetListRewards_fromApi description: 'Get Rewards List from API ' parameters: - name: page in: query schema: $ref: '#/paths/~1cards/get/parameters/0/schema' - name: filter in: query style: deepObject allowReserved: true schema: type: object properties: tags: type: object additionalProperties: type: string transactionId: type: string rewardedTransactionId: type: string receivingAccountId: type: string customerId: type: string cardId: type: string since: type: string until: type: string status: type: string - name: sort in: query schema: type: string - name: include in: query schema: type: string responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetListRewardsFromApiResponse' /rewards/{rewardId}: get: tags: - Get Reward summary: Get Reward by Id operationId: GetReward_byId description: 'Get a Reward from API ' parameters: - description: ID of the reward to get schema: type: string name: rewardId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetRewardByIdResponse' /events: get: tags: - Get List Events summary: Get Events List operationId: GetListEvents_fromApi description: 'Get Events List from API ' parameters: - name: page in: query schema: $ref: '#/paths/~1cards/get/parameters/0/schema' - name: filter in: query style: deepObject allowReserved: true schema: type: object properties: since: type: string until: type: string type: type: array items: type: string responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetListEventsFromApiResponse' /events/{eventId}: get: tags: - Get Event summary: Get Event by Id operationId: GetEvent_byId description: 'Get an Event from API ' parameters: - description: ID of the event to get schema: type: string name: eventId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetEventByIdResponse' post: tags: - Fire Event summary: Fire Event by Id operationId: FireEvent_byId description: 'Fire an Event via API ' parameters: - description: ID of the event to fire schema: type: string name: eventId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/FireEventByIdResponse' /institutions/{routingNumber}: get: tags: - Get Institution summary: Get Institution by Routing Number operationId: GetInstitution_byRoutingNumber description: 'Get an Institution from API ' parameters: - description: routingNumber of the institution to get schema: type: string name: routingNumber in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetInstitutionByRoutingNumberResponse' /fees: post: tags: - Create Fee summary: Create Fee operationId: CreateFee_viaApi description: 'Create a Fee via API ' requestBody: description: Create Fee Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/CreateFeeViaApiRequest' responses: '201': description: Successful Response content: application/vnd.api+json: schema: $ref: '#/components/schemas/CreateFeeViaApiResponse' /check-deposits: get: tags: - Get List Check Deposits summary: Get List Check Deposits operationId: GetListCheckDeposits_fromApi description: 'Get List Check Deposits from API ' parameters: - name: page in: query schema: $ref: '#/paths/~1cards/get/parameters/0/schema' - name: filter in: query style: deepObject allowReserved: true schema: type: object properties: tags: type: object additionalProperties: type: string accountId: type: string customerId: type: string status: type: array items: type: string enum: - AwaitingImages - AwaitingFrontImage - AwaitingBackImage - Pending - PendingReview - Rejected - Clearing - Sent - Canceled - Returned - AwaitingCustomerConfirmation - name: sort in: query schema: type: string - name: include in: query schema: type: string responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetListCheckDepositsFromApiResponse' post: tags: - Create Check Deposit summary: Create Check Deposit operationId: CreateCheckDeposit_viaApi description: 'Create a Check Deposit via API ' requestBody: description: Create Check Deposit Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/CreateCheckDepositViaApiRequest' responses: '201': description: Successful Response content: application/vnd.api+json: schema: $ref: '#/components/schemas/CreateCheckDepositViaApiResponse' /check-deposits/{checkDepositId}: get: tags: - Get Check Deposit summary: Get Check Deposit by Id operationId: GetCheckDeposit_byId description: 'Get a Check Deposit from API ' parameters: - description: ID of the check deposit to get schema: type: string name: checkDepositId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetCheckDepositByIdResponse' patch: tags: - Update Check Deposit summary: Update Check Deposit operationId: UpdateCheckDeposit_byId description: 'Update a Check Deposit via API ' parameters: - description: ID of the check deposit to update schema: type: string name: checkDepositId in: path required: true requestBody: description: Update Check Deposit Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/UpdateCheckDepositByIdRequest' responses: '200': description: Successful Response content: application/vnd.api+json: schema: $ref: '#/components/schemas/UpdateCheckDepositByIdResponse' /check-deposits/{checkDepositId}/confirm: post: tags: - Confirm Check Deposit summary: Confirm by Id operationId: ConfirmCheckDeposit_byId description: 'Confirm a Check Deposit from API ' parameters: - description: ID of the check deposit to confirm schema: type: string name: checkDepositId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/ConfirmCheckDepositByIdResponse' /check-deposits/{checkDepositId}/front: get: tags: - Get Check Deposit Front Image summary: Get Front Check Deposit Image by Id operationId: GetCheckDepositFrontImage_byId description: 'Get Front Check Deposit Image from API ' parameters: - description: ID of the check deposit to get schema: type: string name: checkDepositId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetCheckDepositFrontImageByIdResponse' /check-deposits/{checkDepositId}/back: get: tags: - Get Check Deposit Back Image summary: Get Back Check Deposit Image by Id operationId: GetCheckDepositBackImage_byId description: 'Get Back Check Deposit Image from API ' parameters: - description: ID of the check deposit to get schema: type: string name: checkDepositId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetCheckDepositBackImageByIdResponse' /users/{userId}/api-tokens: get: tags: - Get List Org API Tokens summary: Get List Org API Tokens operationId: GetListOrgApiTokens_fromApi description: 'Get List Org API Tokens from API ' parameters: - description: ID of the user to revoke token schema: type: string name: userId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetListOrgApiTokensFromApiResponse' post: tags: - Create Org Api Token summary: Create Org API Token operationId: CreateOrgApiToken_viaApi description: 'Create an Org API Token via API ' parameters: - description: ID of the user to create token for schema: type: string name: userId in: path required: true requestBody: description: Create Org API Token Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/CreateOrgApiTokenViaApiRequest' responses: '201': description: Successful Response content: application/vnd.api+json: schema: $ref: '#/components/schemas/CreateOrgApiTokenViaApiResponse' /users/{userId}/api-tokens/{tokenId}: delete: tags: - Revoke Org API Token summary: Get Reward by Id operationId: RevokeOrgApiToken_rewardById description: 'Get a Reward from API ' parameters: - description: ID of the user to revoke token schema: type: string name: userId in: path required: true - description: ID of the token to revoke schema: type: string name: tokenId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/RevokeOrgApiTokenRewardByIdResponse' /customers/{customerId}/token: post: tags: - Create Customer Token summary: Create Customer Token operationId: CreateCustomerToken_viaApi description: 'Create a Customer Token via API ' parameters: - description: ID of the customer to create token for schema: type: string name: customerId in: path required: true requestBody: description: Create Customer Token Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/CreateCustomerTokenViaApiRequest' responses: '201': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/CreateCustomerTokenViaApiResponse' /customers/{customerId}/token/verification: post: tags: - Create Customer Token Verification summary: Create Customer Token Verification operationId: CreateCustomerTokenVerification_viaApi description: 'Create a Customer Token Verification via API ' parameters: - description: ID of the customer to create token for schema: type: string name: customerId in: path required: true requestBody: description: Create Customer Token Verification Request required: true content: application/vnd.api+json: schema: $ref: >- #/components/schemas/CreateCustomerTokenVerificationViaApiRequest responses: '201': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/components/schemas/CreateCustomerTokenVerificationViaApiResponse /webhooks: get: tags: - Get List Webhooks summary: Get List Webhooks operationId: GetListWebhooks_fromApi description: 'Get List Webhooks from API ' parameters: - name: page in: query schema: $ref: '#/paths/~1cards/get/parameters/0/schema' - name: filter in: query style: deepObject allowReserved: true schema: type: object properties: since: type: string until: type: string fromId: type: integer toId: type: integer - name: sort in: query schema: type: string responses: '200': description: Successful Response content: application/vnd.api+json: schema: $ref: '#/components/schemas/GetListWebhooksFromApiResponse' post: tags: - Create Webhook summary: Create Webhook operationId: CreateWebhook_viaApi description: 'Create a Webhook via API ' requestBody: description: Create Webhook Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/CreateWebhookViaApiRequest' responses: '201': description: Successful Response content: application/vnd.api+json: schema: $ref: '#/components/schemas/CreateWebhookViaApiResponse' /webhooks/{webhookId}: get: tags: - Get Webhook summary: Get Webhook Id operationId: GetWebhook_byId description: 'Get a Webhook from API ' parameters: - description: ID of the webhook to get schema: type: string name: webhookId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetWebhookByIdResponse' patch: tags: - Update Webhook summary: Update Webhook operationId: UpdateWebhook_viaApi description: 'Update a Webhook via API ' parameters: - description: ID of the Webhook to update schema: type: string name: webhookId in: path required: true requestBody: description: Update Webhook Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/UpdateWebhookViaApiRequest' responses: '201': description: Successful Response content: application/vnd.api+json: schema: $ref: '#/components/schemas/UpdateWebhookViaApiResponse' /webhooks/{webhookId}/enable: post: tags: - Enable Webhook summary: Enable Webhook operationId: EnableWebhook_viaApi description: 'Enable a Webhook via API ' parameters: - description: ID of the webhook to enable schema: type: string name: webhookId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/EnableWebhookViaApiResponse' /webhooks/{webhookId}/disable: post: tags: - Disable Webhook summary: Disable a Webhook operationId: DisableWebhook_viaApi description: 'Disable a Webhook via API ' parameters: - description: ID of the webhook to disable schema: type: string name: webhookId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/DisableWebhookViaApiResponse' /atm-locations: get: tags: - Get ATM Locations List summary: Get List ATM Locations operationId: GetAtmLocationsList_fromApi description: 'Get List ATM Locations from API ' parameters: - name: filter in: query style: deepObject allowReserved: true schema: type: object properties: coordinates: type: object searchRadius: type: integer postalCode: type: string address: type: object responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetAtmLocationsListFromApiResponse' /accounts/{accountId}/transactions/{transactionId}: get: tags: - Get Transaction summary: Get Transaction by Id operationId: GetTransaction_byId description: 'Get a Transaction from API ' parameters: - description: ID of the account to get transaction from schema: type: string name: accountId in: path required: true - description: ID of the transaction schema: type: string name: transactionId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetTransactionByIdResponse' patch: tags: - Update Transaction summary: Update Transaction operationId: UpdateTransaction_viaApi description: 'Update a Transaction via API ' parameters: - description: ID of the account to update transaction from schema: type: string name: accountId in: path required: true - description: ID of the transaction to update schema: type: string name: transactionId in: path required: true requestBody: description: Update Transaction Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/UpdateTransactionViaApiRequest' responses: '200': description: Successful Response content: application/vnd.api+json: schema: $ref: '#/components/schemas/UpdateTransactionViaApiResponse' /transactions: get: tags: - Get List Transactions summary: Get List Transactions operationId: GetListTransactions_fromApi description: 'Get List Transactions from API ' parameters: - name: page in: query schema: $ref: '#/paths/~1cards/get/parameters/0/schema' - name: filter in: query style: deepObject allowReserved: true schema: type: object properties: tags: type: object additionalProperties: type: string accountId: type: string customerId: type: string query: type: string since: type: string until: type: string cardId: type: string excludeFees: type: boolean type: type: array items: type: string direction: type: array items: type: string enum: - Debit - Credit fromAmount: type: integer toAmount: type: integer accountType: type: string - name: sort in: query schema: type: string - name: include in: query schema: type: string responses: '200': description: Successful Response content: application/vnd.api+json: schema: $ref: '#/components/schemas/GetListTransactionsFromApiResponse' /disputes: get: tags: - Get List Disputes summary: Get List Disputes operationId: GetListDisputes_fromApi description: 'Get List Disputes from API ' parameters: - name: page in: query schema: $ref: '#/paths/~1cards/get/parameters/0/schema' - name: filter in: query style: deepObject allowReserved: true schema: type: object properties: query: type: string responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetListDisputesFromApiResponse' /disputes/{disputeId}: get: tags: - Get Dispute summary: Get Dispute by Id operationId: GetDispute_byId description: 'Get a Dispute from API ' parameters: - description: ID of the dispute to get schema: type: string name: disputeId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetDisputeByIdResponse' /repayments: get: tags: - Get List Repayments summary: Get List Repayments operationId: GetListRepayments_fromApi description: 'Get List Repayments from API ' parameters: - name: page in: query schema: $ref: '#/paths/~1cards/get/parameters/0/schema' - name: filter in: query style: deepObject allowReserved: true schema: type: object properties: accountId: type: string creditAccountId: type: string customerId: type: string status: type: array items: type: string enum: - Pending - PendingReview - Returned - Sent - Rejected type: type: array items: type: string enum: - AchRepayment - BookRepayment responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetListRepaymentsFromApiResponse' '401': $ref: '#/paths/~1accounts/get/responses/401' post: tags: - Create a Repayment summary: Create a Repayment operationId: CreateARepayment_viaApi description: 'Create a Repayment via API ' requestBody: description: Create a Repayment Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/CreateARepaymentViaApiRequest' responses: '201': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/CreateARepaymentViaApiResponse' default: $ref: '#/paths/~1accounts/get/responses/401' /repayments/{repaymentId}: get: tags: - Get Repayment summary: Get Repayment by Id operationId: GetRepayment_byId description: 'Get an Repayment from API ' parameters: - description: ID of the repayment to get schema: type: string name: repaymentId in: path required: true - name: include in: query schema: type: string responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/paths/~1repayments/post/responses/201/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema /check-payments: get: tags: - Get List Check Payments summary: Get List Check Payments operationId: GetListCheckPayments_fromApi description: 'Get List Check Payments from API ' parameters: - name: page in: query schema: $ref: '#/paths/~1cards/get/parameters/0/schema' - name: filter in: query schema: type: object properties: tags: type: object additionalProperties: type: string accountId: type: string customerId: type: string status: type: array items: type: string enum: - New - Pending - Canceled - Rejected - InDelivery - InProduction - Delivered - ReturnedToSender - Processed - PendingReview - MarkedForReturn - Returned since: type: string until: type: string fromAmount: type: integer toAmount: type: integer checkNumber: type: string - name: sort in: query schema: type: string - name: include in: query schema: type: string responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: '#/components/schemas/GetListCheckPaymentsFromApiResponse' post: tags: - Create Check Payment summary: Create Check Payment operationId: CreateCheckPayment_viaApi description: 'Create Check Payment via API ' requestBody: description: Create Check Payment Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/CreateCheckPaymentViaApiRequest' responses: '201': description: Successful Response content: application/vnd.api+json: schema: $ref: '#/components/schemas/CreateCheckPaymentViaApiResponse' /check-payments/{checkPaymentId}: get: tags: - Get Check Payment summary: Get Check Payment by Id operationId: GetCheckPayment_byId description: 'Get a Check Payment from API ' parameters: - description: ID of the check payment to get schema: type: string name: checkPaymentId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/paths/~1check-payments/post/responses/201/content/application~1vnd.api%2Bjson/schema /check-payments/{checkPaymentId}/approve: post: tags: - Approve Check Payment summary: Approve Check Payment by Id operationId: ApproveCheckPayment_byId description: 'Approve a Check Payment via API ' parameters: - description: ID of the check payment to approve schema: type: string name: checkPaymentId in: path required: true requestBody: description: Approve Check Payment Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApproveCheckPaymentByIdRequest' responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/paths/~1check-payments/post/responses/201/content/application~1vnd.api%2Bjson/schema /check-payments/{checkPaymentId}/cancel: post: tags: - Cancel Check Payment summary: Cancel Check Payment by Id operationId: CancelCheckPayment_byId description: 'Cancel a Check Payment via API ' parameters: - description: ID of the check payment to cancel schema: type: string name: checkPaymentId in: path required: true responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/paths/~1check-payments/post/responses/201/content/application~1vnd.api%2Bjson/schema /check-payments/{checkPaymentId}/return: post: tags: - Return Check Payment summary: Return Check Payment by Id operationId: ReturnCheckPayment_byId description: 'Return a Check Payment via API ' parameters: - description: ID of the check payment to return schema: type: string name: checkPaymentId in: path required: true requestBody: description: Return Check Payment Request required: true content: application/vnd.api+json: schema: $ref: '#/components/schemas/ReturnCheckPaymentByIdRequest' responses: '200': description: Successful Response content: application/vnd.api+json; charset=utf-8: schema: $ref: >- #/paths/~1check-payments/post/responses/201/content/application~1vnd.api%2Bjson/schema /check-payments/{checkPaymentId}/front: get: tags: - Get a front image summary: Get front image operationId: GetAFrontImage_viaApi description: 'Get front image via API ' parameters: - description: ID of the check payment schema: type: string name: checkPaymentId in: path required: true responses: '200': description: Successful Response content: image/png: schema: $ref: '#/components/schemas/GetAFrontImageViaApiResponse' /check-payments/{checkPaymentId}/back: get: tags: - Get a back image summary: Get back image operationId: GetABackImage_byApi description: 'Get back image via API ' parameters: - description: ID of the check payment schema: type: string name: checkPaymentId in: path required: true responses: '200': description: Successful Response content: image/png: schema: $ref: '#/components/schemas/GetABackImageByApiResponse' /stop-payments: post: tags: - StopPayment summary: Create Stop Payment operationId: StopPayment_create requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StopPaymentCreateRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StopPaymentCreateResponse' get: tags: - StopPayment summary: Get a list of stop payments operationId: StopPayment_getList parameters: - name: page in: query schema: $ref: '#/paths/~1cards/get/parameters/0/schema' - name: filter in: query schema: type: object properties: tags: type: object additionalProperties: type: string accountId: type: string customerId: type: string status: type: array items: type: string enum: - Active - Disabled since: type: string until: type: string fromAmount: type: integer toAmount: type: integer checkNumber: type: string - name: sort in: query schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/StopPaymentGetListResponse' /stop-payments/{stop_payment_id}: get: tags: - StopPayment summary: Get details of a specific stop payment operationId: StopPayment_getDetails parameters: - description: ID of the stop payment name: stop_payment_id in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: >- #/paths/~1stop-payments/post/responses/200/content/application~1json/schema '404': description: Stop payment not found delete: tags: - StopPayment summary: Cancel a stop payment operationId: StopPayment_cancel parameters: - description: ID of the stop payment name: stop_payment_id in: path required: true schema: type: string responses: '204': description: Stop payment successfully canceled '404': description: Stop payment not found /stop-payments/{stop_payment_id}/disable: post: tags: - StopPayment summary: Disable a stop payment operationId: StopPayment_disableStopPayment parameters: - description: ID of the stop payment name: stop_payment_id in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: >- #/paths/~1stop-payments/post/responses/200/content/application~1json/schema '404': description: Stop payment not found components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT schemas: nationalityNullable: type: string pattern: >- ^(A(D|E|F|G|I|L|M|N|O|R|S|T|Q|U|W|X|Z)|B(A|B|D|E|F|G|H|I|J|L|M|N|O|Q|R|S|T|V|W|Y|Z)|C(A|C|D|F|G|H|I|K|L|M|N|O|R|U|V|W|X|Y|Z)|D(E|J|K|M|O|Z)|E(C|E|G|H|R|S|T)|F(I|J|K|M|O|R)|G(A|B|D|E|F|G|H|I|L|M|N|P|Q|R|S|T|U|W|Y)|H(K|M|N|R|T|U)|I(D|E|Q|L|M|N|O|R|S|T)|J(E|M|O|P)|K(E|G|H|I|M|N|P|R|W|Y|Z)|L(A|B|C|I|K|R|S|T|U|V|Y)|M(A|C|D|E|F|G|H|K|L|M|N|O|Q|P|R|S|T|U|V|W|X|Y|Z)|N(A|C|E|F|G|I|L|O|P|R|U|Z)|OM|P(A|E|F|G|H|K|L|M|N|R|S|T|W|Y)|QA|R(E|O|S|U|W)|S(A|B|C|D|E|G|H|I|J|K|L|M|N|O|R|T|V|X|Y|Z)|T(C|D|F|G|H|J|K|L|M|N|O|R|T|V|W|Z)|U(A|G|M|S|Y|Z)|V(A|C|E|G|I|N|U)|W(F|S)|XK|Y(E|T)|Z(A|M|W))$ nullable: true addressNullable: title: Address type: object properties: street: type: string minLength: 1 maxLength: 255 pattern: ^.*$ street2: type: string nullable: true pattern: ^.*$ city: type: string minLength: 1 maxLength: 255 pattern: ^.*$ state: type: string postalCode: type: string pattern: ^[0-9]{5}(?:-[0-9]{4})?$ country: type: string default: US required: - street - city - postalCode - country - state nullable: true idNullable: type: string pattern: ^[1-9]\d*$ nullable: true UpdateApplicationViaApiRequest: title: Patch Application definitions: contact: title: Contact type: object properties: fullName: title: Full Name type: object properties: first: type: string minLength: 1 maxLength: 255 last: type: string minLength: 1 maxLength: 255 required: - first - last email: type: string format: email phone: title: Phone type: object properties: countryCode: type: string number: type: string required: - countryCode - number grantor: title: Grantor type: object properties: fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName ssn: type: string pattern: ^\d{9}$ passport: type: string nationality: type: string pattern: >- ^(A(D|E|F|G|I|L|M|N|O|R|S|T|Q|U|W|X|Z)|B(A|B|D|E|F|G|H|I|J|L|M|N|O|Q|R|S|T|V|W|Y|Z)|C(A|C|D|F|G|H|I|K|L|M|N|O|R|U|V|W|X|Y|Z)|D(E|J|K|M|O|Z)|E(C|E|G|H|R|S|T)|F(I|J|K|M|O|R)|G(A|B|D|E|F|G|H|I|L|M|N|P|Q|R|S|T|U|W|Y)|H(K|M|N|R|T|U)|I(D|E|Q|L|M|N|O|R|S|T)|J(E|M|O|P)|K(E|G|H|I|M|N|P|R|W|Y|Z)|L(A|B|C|I|K|R|S|T|U|V|Y)|M(A|C|D|E|F|G|H|K|L|M|N|O|Q|P|R|S|T|U|V|W|X|Y|Z)|N(A|C|E|F|G|I|L|O|P|R|U|Z)|OM|P(A|E|F|G|H|K|L|M|N|R|S|T|W|Y)|QA|R(E|O|S|U|W)|S(A|B|C|D|E|G|H|I|J|K|L|M|N|O|R|T|V|X|Y|Z)|T(C|D|F|G|H|J|K|L|M|N|O|R|T|V|W|Z)|U(A|G|M|S|Y|Z)|V(A|C|E|G|I|N|U)|W(F|S)|XK|Y(E|T)|Z(A|M|W))$ matriculaConsular: type: string address: title: Address type: object properties: street: type: string minLength: 1 maxLength: 255 pattern: ^.*$ street2: type: string nullable: true pattern: ^.*$ city: type: string minLength: 1 maxLength: 255 pattern: ^.*$ state: type: string postalCode: type: string pattern: ^[0-9]{5}(?:-[0-9]{4})?$ country: type: string default: US required: - street - city - postalCode - country - state dateOfBirth: type: string format: date phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone email: type: string format: email officer: title: Officer type: object properties: fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName ssn: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/ssn passport: type: string nationality: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality matriculaConsular: type: string address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address dateOfBirth: type: string format: date phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone email: type: string format: email occupation: type: string enum: - ArchitectOrEngineer - BusinessAnalystAccountantOrFinancialAdvisor - CommunityAndSocialServicesWorker - ConstructionMechanicOrMaintenanceWorker - Doctor - Educator - EntertainmentSportsArtsOrMedia - ExecutiveOrManager - FarmerFishermanForester - FoodServiceWorker - GigWorker - HospitalityOfficeOrAdministrativeSupportWorker - HouseholdManager - JanitorHousekeeperLandscaper - Lawyer - ManufacturingOrProductionWorker - MilitaryOrPublicSafety - NurseHealthcareTechnicianOrHealthcareSupport - PersonalCareOrServiceWorker - PilotDriverOperator - SalesRepresentativeBrokerAgent - ScientistOrTechnologist - Student annualIncome: type: string enum: - UpTo10k - Between10kAnd25k - Between25kAnd50k - Between50kAnd100k - Between100kAnd250k - Over250k sourceOfIncome: type: string enum: - EmploymentOrPayrollIncome - PartTimeOrContractorIncome - InheritancesAndGifts - PersonalInvestments - BusinessOwnershipInterests - GovernmentBenefits beneficialOwner: title: Beneficial Owner type: object properties: ssn: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/ssn passport: type: string nationality: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality matriculaConsular: type: string address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address dateOfBirth: type: string format: date occupation: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/occupation annualIncome: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/annualIncome sourceOfIncome: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/sourceOfIncome patchIndividualApplication: title: Patch Individual Application type: object properties: type: type: string default: individualApplication attributes: type: object properties: tags: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchTransactionTags/properties/attributes/properties/tags occupation: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/occupation annualIncome: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/annualIncome sourceOfIncome: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/sourceOfIncome required: - type - attributes patchBusinessApplication: title: Patch Business Application type: object properties: type: type: string default: businessApplication attributes: type: object properties: tags: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchTransactionTags/properties/attributes/properties/tags annualRevenue: type: string enum: - UpTo250k - Between250kAnd500k - Between500kAnd1m - Between1mAnd5m - Over5m numberOfEmployees: type: string enum: - UpTo10 - Between10And50 - Between50And100 - Between100And500 - Over500 cashFlow: type: string enum: - Unpredictable - Predictable yearOfIncorporation: type: string pattern: ^\d{4}$ countriesOfOperation: type: array items: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality minItems: 1 stockSymbol: type: string website: type: string businessVertical: type: string enum: - AdultEntertainmentDatingOrEscortServices - AgricultureForestryFishingOrHunting - ArtsEntertainmentAndRecreation - BusinessSupportOrBuildingServices - Cannabis - Construction - DirectMarketingOrTelemarketing - EducationalServices - FinancialServicesCryptocurrency - FinancialServicesDebitCollectionOrConsolidation - FinancialServicesMoneyServicesBusinessOrCurrencyExchange - FinancialServicesOther - FinancialServicesPaydayLending - GamingOrGambling - HealthCareAndSocialAssistance - HospitalityAccommodationOrFoodServices - LegalAccountingConsultingOrComputerProgramming - Manufacturing - Mining - Nutraceuticals - PersonalCareServices - PublicAdministration - RealEstate - ReligiousCivicAndSocialOrganizations - RepairAndMaintenance - RetailTrade - TechnologyMediaOrTelecom - TransportationOrWarehousing - Utilities - WholesaleTrade required: - type - attributes patchBusinessApplicationOfficer: title: Patch Business Application type: object properties: type: type: string default: businessApplication attributes: type: object properties: officer: type: object properties: occupation: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/occupation annualIncome: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/annualIncome sourceOfIncome: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/sourceOfIncome required: - type - attributes patchBusinessApplicationBeneficialOwner: title: Patch Business Application type: object properties: type: type: string default: beneficialOwner attributes: type: object properties: occupation: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/occupation annualIncome: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/annualIncome sourceOfIncome: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/sourceOfIncome relationships: type: object properties: application: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account required: - type - attributes patchTrustApplication: title: Patch Trust Application type: object properties: type: type: string default: trustApplication attributes: type: object properties: tags: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchTransactionTags/properties/attributes/properties/tags required: - type - attributes patchSoleProprietorApplication: title: Patch Individual Application type: object properties: type: type: string default: individualApplication attributes: type: object properties: tags: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchTransactionTags/properties/attributes/properties/tags annualRevenue: type: string enum: - UpTo50k - Between50kAnd100k - Between100kAnd200k - Between200kAnd500k - Over500k numberOfEmployees: type: string enum: - One - Between2And5 - Between5And10 - Over10 businessVertical: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/businessVertical website: type: string required: - type - attributes type: object properties: data: oneOf: - $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication - $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplicationOfficer - $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplicationBeneficialOwner - $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchSoleProprietorApplication - $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchIndividualApplication - $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchTrustApplication required: - data CancelApplicationByIdRequest: title: CancelApplicationRequest type: object properties: data: type: object properties: type: type: string enum: - cancelApplication attributes: type: object properties: reason: type: string CreateApplicationViaApiRequest: definitions: evaluationParams: title: EvaluationParams type: object properties: useSelfieVerification: type: string enum: - Never - ReplaceIdentification - Always requireIdVerification: type: boolean default: false createPowerOfAttorneyAgent: title: CreatePowerOfAttorneyAgent type: object properties: fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone ssn: type: string pattern: ^\d{9}$ passport: type: string nationality: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality matriculaConsular: type: string address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address dateOfBirth: type: string format: date jwtSubject: type: string nullable: true evaluationParams: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/evaluationParams required: - fullName - email - phone - address - dateOfBirth createOfficer: title: CreateOfficer type: object properties: title: type: string enum: - President - CEO - COO - CFO - BenefitsAdministrationOfficer - CIO - VP - AVP - Treasurer - Secretary - Controller - Manager - Partner - Member fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName email: type: string format: email phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone ssn: type: string pattern: ^\d{9}$ passport: type: string nationality: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality matriculaConsular: type: string address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address dateOfBirth: type: string format: date evaluationParams: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/evaluationParams occupation: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/occupation annualIncome: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/annualIncome sourceOfIncome: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/sourceOfIncome required: - fullName - email - phone - address - dateOfBirth - occupation createBeneficialOwner: title: CreateBeneficialOwner type: object properties: fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone ssn: type: string pattern: ^\d{9}$ passport: type: string nationality: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality matriculaConsular: type: string address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address dateOfBirth: type: string format: date percentage: type: integer minimum: 0 maximum: 100 evaluationParams: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/evaluationParams occupation: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/occupation annualIncome: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/annualIncome sourceOfIncome: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/sourceOfIncome required: - fullName - email - phone - address - dateOfBirth CreateIndividualApplication: title: Create Individual Application type: object properties: type: type: string default: individualApplication attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone ssn: type: string nullable: true pattern: ^\d{9}|\d{4} passport: type: string nullable: true nationality: $ref: '#/components/schemas/nationalityNullable' address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address dateOfBirth: type: string format: date ip: type: string idempotencyKey: type: string minLength: 1 maxLength: 255 deviceFingerprints: type: array maxItems: 1 items: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateTrustApplication/properties/attributes/properties/deviceFingerprints/items jwtSubject: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent/properties/jwtSubject powerOfAttorneyAgent: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent industry: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/industry evaluationParams: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/evaluationParams occupation: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/occupation annualIncome: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/annualIncome sourceOfIncome: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/sourceOfIncome required: - fullName - email - phone - address - dateOfBirth required: - type - attributes CreateSoleProprietorApplication: title: Create Sole Proprietor Application type: object properties: type: type: string default: individualApplication attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone ssn: type: string nullable: true pattern: ^\d{9}|\d{4} passport: type: string nullable: true nationality: $ref: '#/components/schemas/nationalityNullable' matriculaConsular: type: string nullable: true address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address dateOfBirth: type: string format: date dba: type: string nullable: true ein: type: string nullable: true pattern: ^\d{9}$ ip: type: string soleProprietorship: type: boolean default: false idempotencyKey: type: string minLength: 1 maxLength: 255 deviceFingerprints: type: array maxItems: 1 items: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateTrustApplication/properties/attributes/properties/deviceFingerprints/items jwtSubject: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent/properties/jwtSubject powerOfAttorneyAgent: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent industry: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/industry evaluationParams: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/evaluationParams occupation: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/occupation annualIncome: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/annualIncome sourceOfIncome: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/sourceOfIncome annualRevenue: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchSoleProprietorApplication/properties/attributes/properties/annualRevenue numberOfEmployees: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchSoleProprietorApplication/properties/attributes/properties/numberOfEmployees businessVertical: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/businessVertical website: type: string required: - fullName - email - phone - address - dateOfBirth required: - type - attributes CreateBusinessApplication: title: Create Business Application type: object properties: type: type: string default: businessApplication attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags name: type: string minLength: 1 maxLength: 255 dba: type: string minLength: 1 maxLength: 255 ein: type: string pattern: ^\d{9}$ entityType: type: string enum: - Corporation - LLC - Partnership - PubliclyTradedCorporation - PrivatelyHeldCorporation - NotForProfitOrganization dateOfIncorporation: type: string format: date stateOfIncorporation: type: string minLength: 2 maxLength: 2 purpose: type: string minLength: 1 maxLength: 1024 phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address contact: title: Contact type: object properties: fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone jwtSubject: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent/properties/jwtSubject officer: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer ip: type: string website: type: string beneficialOwners: type: array items: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createBeneficialOwner idempotencyKey: type: string minLength: 1 maxLength: 255 deviceFingerprints: type: array maxItems: 1 items: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateTrustApplication/properties/attributes/properties/deviceFingerprints/items industry: type: string enum: - Retail - Wholesale - Restaurants - Hospitals - Construction - Insurance - Unions - RealEstate - FreelanceProfessional - OtherProfessionalServices - OnlineRetailer - OtherEducationServices annualRevenue: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/annualRevenue numberOfEmployees: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/numberOfEmployees cashFlow: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/cashFlow yearOfIncorporation: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/yearOfIncorporation countriesOfOperation: type: array items: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality minItems: 1 stockSymbol: type: string minLength: 1 maxLength: 5 businessVertical: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/businessVertical required: - name - ein - entityType - stateOfIncorporation - phone - address - contact - officer - beneficialOwners required: - type - attributes CreateTrustApplication: title: Create Trust Application type: object properties: type: type: string default: trustApplication attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags name: type: string minLength: 1 maxLength: 255 stateOfIncorporation: type: string minLength: 2 maxLength: 2 revocability: type: string enum: - Revocable - Irrevocable sourceOfFunds: type: string enum: - Inheritance - Salary - Savings - InvestmentReturns - Gifts taxId: type: string grantor: title: Grantor type: object properties: fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone ssn: type: string pattern: ^\d{9}$ passport: type: string matriculaConsular: type: string nationality: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address dateOfBirth: type: string format: date evaluationId: type: string evaluationFlags: type: array items: type: string status: type: string maskedSSN: type: string pattern: ^\*{5}\d{4}$ required: - fullName - email - phone - address - dateOfBirth trustees: type: array items: title: Trustee type: object properties: fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone ssn: type: string pattern: ^\d{9}$ passport: type: string nationality: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality matriculaConsular: type: string address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address dateOfBirth: type: string format: date required: - fullName - email - phone - address - dateOfBirth beneficiaries: type: array items: title: Beneficiary type: object properties: fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName dateOfBirth: type: string format: date required: - fullName - dateOfBirth contact: title: TrustContact type: object properties: fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address jwtSubject: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent/properties/jwtSubject ip: type: string idempotencyKey: type: string minLength: 1 maxLength: 255 deviceFingerprints: type: array maxItems: 1 items: type: object properties: provider: type: string enum: - iovation value: type: string required: - provider - value required: - name - stateOfIncorporation - revocability - sourceOfFunds - taxId - grantor - trustees - beneficiaries - contact required: - type - attributes type: object properties: data: oneOf: - $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateIndividualApplication - $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateSoleProprietorApplication - $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication - $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateTrustApplication required: - data CreateApplicationFormViaApiRequest: definitions: requireIdVerification: type: object properties: individual: type: boolean default: false officer: type: boolean default: false beneficialOwners: type: boolean default: false type: object properties: data: type: object properties: type: type: string default: applicationForm attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags applicantDetails: $ref: >- #/paths/~1application-forms/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/ApplicationFormPrefill settingsOverride: $ref: >- #/paths/~1application-forms/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/ApplicationFormSettingsOverride requireIdVerification: $ref: >- #/paths/~1application-forms/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/requireIdVerification allowedApplicationTypes: type: array items: type: string enum: - Individual - Business - SoleProprietorship lang: type: string enum: - en - es hideApplicationProgressTracker: type: boolean relationships: title: createApplicationFormRelationships type: object properties: application: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account required: [] required: - type UploadAPngDocumentForAnApplicationByIdRequest: type: object UploadAJpegDocumentForAnApplicationViaApiRequest: type: object UploadAPngDocumentForAnApplicationBackSidePutRequest: type: object UploadAJpegDocumentForAnApplicationBackSidePutRequest: type: object VerifyADocumentForAnApplicationPutRequest: title: VerifyDocument type: object properties: jobId: type: string CreateAccountViaApiRequest: definitions: CreateCreditAccount: title: Create Credit Account type: object properties: type: type: string default: creditAccount enum: - creditAccount attributes: type: object properties: tags: type: object nullable: true creditTerms: type: string creditLimit: type: integer idempotencyKey: type: string nullable: true required: - creditTerms - creditLimit relationships: type: object properties: customer: $ref: >- #/paths/~1customers/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items/definitions/customerLinkage CreateDepositAccount: title: Create Deposit Account type: object properties: type: type: string default: depositAccount enum: - depositAccount attributes: type: object properties: tags: type: object nullable: true depositProduct: type: string idempotencyKey: type: string nullable: true required: - depositProduct relationships: type: object properties: customer: $ref: >- #/paths/~1customers/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items/definitions/customerLinkage customers: title: Customers Relationship type: object properties: data: type: array items: type: object properties: id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id type: type: string default: customer type: object properties: data: oneOf: - $ref: >- #/paths/~1accounts/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateCreditAccount - $ref: >- #/paths/~1accounts/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateDepositAccount required: - data UpdateAccountViaApiRequest: title: Update Account definitions: updateDepositAccount: title: Update Deposit Account type: object properties: type: type: string default: depositAccount attributes: type: object properties: tags: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchTransactionTags/properties/attributes/properties/tags depositProduct: type: string required: - type - attributes updateCreditAccount: title: Update Credit Account type: object properties: type: type: string default: creditAccount attributes: type: object properties: tags: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchTransactionTags/properties/attributes/properties/tags creditLimit: type: integer required: - type - attributes type: object properties: data: oneOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/updateDepositAccount - $ref: >- #/paths/~1accounts~1%7BaccountId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/updateCreditAccount required: - data FreezeAnAccountByIdRequest: title: FreezeAccountRequest type: object properties: data: type: object properties: type: type: string enum: - creditAccountFreeze - accountFreeze attributes: type: object properties: reason: type: string enum: - Fraud - Other reasonText: type: string nullable: true CloseAnAccountByIdRequest: title: CloseAccountRequest type: object properties: data: title: CloseAccountRequest type: object properties: type: type: string enum: - creditAccountClose - depositAccountClose attributes: type: object properties: reason: type: string enum: - ByCustomer - Fraud default: ByCustomer fraudReason: type: string enum: - ACHActivity - CardActivity - CheckActivity - ApplicationHistory - AccountActivity - ClientIdentified - IdentityTheft - LinkedToFraudulentCustomer nullable: true UpdateCustomerViaApiRequest: title: Patch Customer definitions: relationships: type: object properties: org: type: object properties: data: type: object properties: id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id type: type: string default: org required: - id - type required: - data application: type: object properties: type: type: string enum: - businessApplication - individualApplication id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id updateIndividualCustomer: title: UpdateIndividualCustomer type: object properties: type: type: string attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email nullable: true phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone nullable: true address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address nullable: true dba: type: string nullable: true authorizedUsers: type: array items: $ref: >- #/paths/~1customers~1%7BcustomerId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/updateTrustCustomer/properties/attributes/properties/authorizedUsers/items nullable: true jwtSubject: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent/properties/jwtSubject nullable: true updateBusinessCustomer: title: UpdateBusinessCustomer type: object properties: type: type: string attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags nullable: true dba: type: string nullable: true ein: type: string pattern: ^\d{9}$ phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone nullable: true address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address nullable: true contact: nullable: true allOf: - $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/contact required: - fullName authorizedUsers: type: array items: $ref: >- #/paths/~1customers~1%7BcustomerId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/updateTrustCustomer/properties/attributes/properties/authorizedUsers/items nullable: true updateTrustCustomer: title: UpdateTrustCustomer type: object properties: type: type: string attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags nullable: true contact: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateTrustApplication/properties/attributes/properties/contact nullable: true authorizedUsers: type: array items: title: Authorized User type: object properties: fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone jwtSubject: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent/properties/jwtSubject required: - fullName - email - phone nullable: true type: object properties: data: oneOf: - $ref: >- #/paths/~1customers~1%7BcustomerId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/updateIndividualCustomer - $ref: >- #/paths/~1customers~1%7BcustomerId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/updateBusinessCustomer - $ref: >- #/paths/~1customers~1%7BcustomerId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/updateTrustCustomer ArchiveCustomerByIdRequest: title: ArchiveCustomerRequest type: object properties: type: type: string enum: - archiveCustomer attributes: type: object properties: reason: type: string enum: - Inactive - FraudACHActivity - FraudCardActivity - FraudCheckActivity - FraudApplicationHistory - FraudAccountActivity - FraudClientIdentified - FraudLinkedToFraudulentCustomer CreateAPaymentViaApiRequest: definitions: accountRelationship: type: object properties: data: type: object properties: type: type: string enum: - account - depositAccount - creditAccount - batchAccount id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data counterpartyRelationship: type: object properties: data: type: object properties: type: type: string enum: - account - depositAccount - counterparty id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data counterpartyAccountRelationship: type: object properties: data: type: object properties: type: type: string enum: - account - depositAccount id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data CreateAchPayment: title: Create ACH Payment to inline Counterparty type: object properties: type: type: string default: achPayment attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags description: type: string amount: type: integer addenda: type: string direction: type: string enum: - Debit - Credit counterparty: $ref: >- #/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/counterparty idempotencyKey: type: string sameDay: type: boolean secCode: type: string enum: - WEB - CCD - PPD required: - amount - description - direction - counterparty relationships: type: object properties: account: $ref: >- #/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship required: - account required: - attributes - relationships CreateAchPaymentCounterparty: title: Create ACH Payment to linked Counterparty type: object properties: type: type: string default: achPayment attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags description: type: string amount: type: integer addenda: type: string direction: type: string enum: - Debit - Credit sameDay: type: boolean idempotencyKey: type: string verifyCounterpartyBalance: type: boolean default: false secCode: type: string enum: - WEB - CCD - PPD required: - amount - description - direction relationships: type: object properties: account: $ref: >- #/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship counterparty: $ref: >- #/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/counterpartyRelationship required: - account - counterparty required: - attributes - relationships CreateAchPaymentPlaid: title: Create ACH Payment with Plaid token type: object properties: type: type: string default: achPayment attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags description: type: string amount: type: integer addenda: type: string direction: type: string enum: - Debit - Credit idempotencyKey: type: string plaidProcessorToken: type: string pattern: ^processor-.*$ counterpartyName: type: string sameDay: type: boolean verifyCounterpartyBalance: type: boolean default: false secCode: type: string enum: - WEB - CCD - PPD required: - amount - description - direction - plaidProcessorToken relationships: type: object properties: account: $ref: >- #/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship required: - account required: - attributes - relationships CreateBookPayment: title: Create Book Payment type: object properties: type: type: string default: bookPayment attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags description: type: string amount: type: integer idempotencyKey: type: string transactionSummaryOverride: type: string required: - amount - description relationships: type: object properties: account: $ref: >- #/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship counterpartyAccount: $ref: >- #/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/counterpartyAccountRelationship required: - account - counterpartyAccount required: - attributes - relationships CreateWirePayment: title: Create Wire Payment type: object properties: type: type: string default: wirePayment attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags description: type: string amount: type: integer direction: type: string enum: - Credit counterparty: $ref: >- #/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/wireCounterparty idempotencyKey: type: string required: - amount - description - counterparty relationships: type: object properties: account: $ref: >- #/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship required: - account required: - attributes - relationships CreateBillPayment: title: Create Bill Payment type: object properties: type: type: string default: billPayment attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags description: type: string billerId: type: string accountNumber: type: string amount: type: integer idempotencyKey: type: string fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName dateOfBirth: type: string format: date required: - billerId - accountNumber - amount - description relationships: type: object properties: account: $ref: >- #/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship required: - account required: - attributes - relationships CreatePushToCardPayment: title: Create Push To Card Payment type: object properties: type: type: string default: pushToCardPayment attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags description: type: string amount: type: integer idempotencyKey: type: string configuration: type: object properties: astra: $ref: >- #/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/astra required: - amount - description - configuration relationships: type: object properties: account: $ref: >- #/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship required: - account required: - attributes - relationships additionalProperties: false type: object properties: data: oneOf: - $ref: >- #/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateAchPayment - $ref: >- #/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateAchPaymentCounterparty - $ref: >- #/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateAchPaymentPlaid - $ref: >- #/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBookPayment - $ref: >- #/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateWirePayment - $ref: >- #/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBillPayment - $ref: >- #/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreatePushToCardPayment UpdatePaymentViaApiRequest: title: Patch Payment definitions: patchAchPayment: title: Patch ACH Payment type: object properties: type: type: string default: achPayment attributes: type: object properties: tags: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchTransactionTags/properties/attributes/properties/tags required: - type - attributes patchBookPayment: title: Patch Book Payment type: object properties: type: type: string default: bookPayment attributes: type: object properties: tags: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchTransactionTags/properties/attributes/properties/tags required: - type - attributes type: object properties: data: oneOf: - $ref: >- #/paths/~1payments~1%7BpaymentId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchAchPayment - $ref: >- #/paths/~1payments~1%7BpaymentId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBookPayment required: - data UpdateReceivedPaymentViaApiRequest: title: Patch Received Payment definitions: patchAchReceivedPayment: title: Patch ACH Received Payment type: object properties: type: type: string default: achReceivedPayment attributes: type: object properties: tags: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchTransactionTags/properties/attributes/properties/tags required: - type - attributes type: object properties: data: oneOf: - $ref: >- #/paths/~1received-payments~1%7BpaymentId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchAchReceivedPayment required: - data CreateCounterpartyViaApiRequest: definitions: createCounterpartyRelationships: type: object properties: customer: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account required: - customer CreateAchCounterparty: title: Create Ach Counterparty type: object properties: type: type: string attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags routingNumber: type: string accountNumber: type: string accountType: type: string enum: - Checking - Savings - Loan permissions: type: string enum: - CreditOnly - DebitOnly - CreditAndDebit type: type: string enum: - Business - Person - Unknown name: type: string idempotencyKey: type: string required: - type - name - accountType - accountNumber - routingNumber relationships: $ref: >- #/paths/~1counterparties/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCounterpartyRelationships required: - type - attributes - relationships CreatePlaidCounterparty: title: Create Plaid Counterparty type: object properties: type: type: string attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags type: type: string enum: - Business - Person - Unknown name: type: string verifyName: type: boolean default: false plaidProcessorToken: $ref: >- #/paths/~1counterparties~1%7BcounterpartyId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchCounterparty/properties/attributes/properties/plaidProcessorToken permissions: type: string enum: - CreditOnly - DebitOnly - CreditAndDebit idempotencyKey: type: string required: - type - plaidProcessorToken relationships: $ref: >- #/paths/~1counterparties/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCounterpartyRelationships required: - type - attributes - relationships type: object properties: data: oneOf: - $ref: >- #/paths/~1counterparties/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateAchCounterparty - $ref: >- #/paths/~1counterparties/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreatePlaidCounterparty UpdateCounterpartyViaApiRequest: title: Patch Counterparty definitions: patchCounterparty: title: Patch Counterparty type: object properties: type: type: string default: counterparty attributes: type: object properties: tags: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchTransactionTags/properties/attributes/properties/tags plaidProcessorToken: type: string pattern: ^processor-.*$ minLength: 40 maxLength: 60 name: type: string minLength: 1 maxLength: 50 permissions: type: string enum: - CreditOnly - DebitOnly - CreditAndDebit verifyName: type: boolean default: false required: - type - attributes type: object properties: data: oneOf: - $ref: >- #/paths/~1counterparties~1%7BcounterpartyId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchCounterparty required: - data CreateRecurringPaymentViaApiRequest: definitions: createRecurringCreditAchPayment: title: Create Recurring Credit ACH Payment type: object properties: type: type: string default: recurringCreditAchPayment attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags description: type: string minLength: 1 maxLength: 10 amount: type: integer minimum: 1 addenda: type: string minLength: 1 maxLength: 80 idempotencyKey: type: string minLength: 1 maxLength: 255 schedule: $ref: >- #/paths/~1recurring-payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/schedule required: - amount - description - schedule relationships: type: object properties: account: $ref: >- #/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship counterparty: $ref: >- #/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/counterpartyRelationship required: - account - counterparty required: - type - attributes - relationships createRecurringDebitAchPayment: title: Create Recurring Debit ACH Payment type: object properties: type: type: string default: recurringDebitAchPayment attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags description: type: string minLength: 1 maxLength: 10 amount: type: integer minimum: 1 addenda: type: string minLength: 1 maxLength: 80 idempotencyKey: type: string minLength: 1 maxLength: 255 sameDay: type: boolean default: false verifyCounterpartyBalance: type: boolean default: false schedule: $ref: >- #/paths/~1recurring-payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/schedule clearingDaysOverride: type: integer minimum: 0 required: - amount - description - schedule relationships: type: object properties: account: $ref: >- #/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship counterparty: $ref: >- #/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/counterpartyRelationship required: - account - counterparty required: - type - attributes - relationships createRecurringCreditBookPayment: title: Create Recurring Credit Book Payment type: object properties: type: type: string default: recurringCreditBookPayment attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags description: type: string minLength: 1 maxLength: 80 amount: type: integer minimum: 1 idempotencyKey: type: string minLength: 1 maxLength: 255 transactionSummaryOverride: type: string minLength: 1 maxLength: 100 schedule: $ref: >- #/paths/~1recurring-payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/schedule required: - amount - description - schedule relationships: type: object properties: account: $ref: >- #/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship counterpartyAccount: $ref: >- #/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/counterpartyAccountRelationship required: - account - counterpartyAccount required: - type - attributes - relationships schedule: title: schedule oneOf: - $ref: >- #/paths/~1recurring-payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/monthlySchedule monthlySchedule: title: Create Monthly Schedule type: object properties: startTime: type: string format: date endTime: type: string format: date dayOfMonth: type: integer minimum: -5 maximum: 28 dayOfWeek: type: string enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday interval: type: string enum: - Monthly - Weekly totalNumberOfPayments: type: integer minimum: 1 required: - interval type: object properties: data: oneOf: - $ref: >- #/paths/~1recurring-payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createRecurringCreditAchPayment - $ref: >- #/paths/~1recurring-payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createRecurringDebitAchPayment - $ref: >- #/paths/~1recurring-payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createRecurringCreditBookPayment required: - data CreateACardViaApiRequest: definitions: createCardRelationships: title: createCardRelationships type: object properties: account: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account customer: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account defaultFundingAccount: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account required: - account BIN: type: object properties: bin: type: string pattern: ^\d{9}$ institutionId: type: string pattern: ^\d{9}$ required: - bin - institutionId CreateIndividualDebitCard: title: Create Individual Debit Card type: object properties: type: type: string default: individualDebitCard enum: - individualDebitCard attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags shippingAddress: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address design: type: string limits: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessDebitCard/properties/attributes/properties/limits idempotencyKey: type: string minLength: 1 maxLength: 255 bin: $ref: >- #/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/BIN cardQualifier: type: string pattern: ^(\d{3})|([ ]{3})$ cardDesignId: type: string maxLength: 16 additionalEmbossedText: type: string maxLength: 26 activeForOnlineUse: type: boolean printOnlyBusinessName: type: boolean expiryDate: type: string pattern: >- ^(1[0-2]|0[1-9])/(\d{2})$|^(\d{4})-(1[0-2]|0[1-9])$|^(\d{2})-(1[0-2]|0[1-9])$ relationships: $ref: >- #/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCardRelationships required: - type - attributes - relationships CreateBusinessDebitCard: title: Create Business Debit Card type: object properties: type: type: string default: businessDebitCard enum: - businessDebitCard attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags shippingAddress: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email dateOfBirth: type: string format: date nationality: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality ssn: type: string pattern: ^\d{9}$ passport: type: string design: type: string additionalEmbossedText: type: string maxLength: 26 limits: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessDebitCard/properties/attributes/properties/limits idempotencyKey: type: string minLength: 1 maxLength: 255 activeForOnlineUse: type: boolean printOnlyBusinessName: type: boolean expiryDate: type: string pattern: >- ^(1[0-2]|0[1-9])/(\d{2})$|^(\d{4})-(1[0-2]|0[1-9])$|^(\d{2})-(1[0-2]|0[1-9])$ required: - address - fullName - phone - email - dateOfBirth relationships: $ref: >- #/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCardRelationships required: - type - attributes - relationships CreateBusinessCreditCard: title: Create Business Credit Card type: object properties: type: type: string default: businessCreditCard enum: - businessCreditCard attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags shippingAddress: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email dateOfBirth: type: string format: date nationality: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality ssn: type: string pattern: ^\d{9}$ passport: type: string design: type: string additionalEmbossedText: type: string maxLength: 26 limits: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessDebitCard/properties/attributes/properties/limits idempotencyKey: type: string minLength: 1 maxLength: 255 activeForOnlineUse: type: boolean printOnlyBusinessName: type: boolean expiryDate: type: string pattern: >- ^(1[0-2]|0[1-9])/(\d{2})$|^(\d{4})-(1[0-2]|0[1-9])$|^(\d{2})-(1[0-2]|0[1-9])$ required: - address - fullName - phone - email - dateOfBirth relationships: $ref: >- #/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCardRelationships required: - type - attributes - relationships CreateIndividualVirtualDebitCard: title: Create Individual Virtual Debit Card type: object properties: type: type: string default: individualVirtualDebitCard enum: - individualVirtualDebitCard attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags limits: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessDebitCard/properties/attributes/properties/limits idempotencyKey: type: string minLength: 1 maxLength: 255 bin: $ref: >- #/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/BIN cardQualifier: type: string pattern: ^\d{3}$ expiryDate: type: string pattern: >- ^(1[0-2]|0[1-9])/(\d{2})$|^(\d{4})-(1[0-2]|0[1-9])$|^(\d{2})-(1[0-2]|0[1-9])$ relationships: $ref: >- #/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCardRelationships required: - type - attributes - relationships CreateBusinessVirtualDebitCard: title: Create Business Virtual Debit Card type: object properties: type: type: string default: businessVirtualDebitCard enum: - businessVirtualDebitCard attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email dateOfBirth: type: string format: date nationality: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality ssn: type: string pattern: ^\d{9}$ passport: type: string limits: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessDebitCard/properties/attributes/properties/limits idempotencyKey: type: string minLength: 1 maxLength: 255 expiryDate: type: string pattern: >- ^(1[0-2]|0[1-9])/(\d{2})$|^(\d{4})-(1[0-2]|0[1-9])$|^(\d{2})-(1[0-2]|0[1-9])$ required: - address - fullName - phone - email - dateOfBirth relationships: $ref: >- #/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCardRelationships required: - type - attributes - relationships CreateBusinessVirtualCreditCard: title: Create Business Virtual Credit Card type: object properties: type: type: string default: businessVirtualCreditCard enum: - businessVirtualCreditCard attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email dateOfBirth: type: string format: date nationality: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality ssn: type: string pattern: ^\d{9}$ passport: type: string limits: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessDebitCard/properties/attributes/properties/limits idempotencyKey: type: string minLength: 1 maxLength: 255 expiryDate: type: string pattern: >- ^(1[0-2]|0[1-9])/(\d{2})$|^(\d{4})-(1[0-2]|0[1-9])$|^(\d{2})-(1[0-2]|0[1-9])$ required: - address - fullName - phone - email - dateOfBirth relationships: $ref: >- #/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCardRelationships required: - type - attributes - relationships type: object properties: data: oneOf: - $ref: >- #/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateIndividualDebitCard - $ref: >- #/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessDebitCard - $ref: >- #/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessCreditCard - $ref: >- #/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateIndividualVirtualDebitCard - $ref: >- #/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessVirtualDebitCard - $ref: >- #/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessVirtualCreditCard UpdateCardViaApiRequest: title: Patch Card definitions: patchIndividualDebitCard: title: Patch Individual Debit Card type: object properties: type: type: string enum: - individualDebitCard attributes: type: object properties: tags: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchTransactionTags/properties/attributes/properties/tags shippingAddress: $ref: '#/components/schemas/addressNullable' design: type: string limits: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessDebitCard/properties/attributes/properties/limits defaultFundingAccountId: $ref: '#/components/schemas/idNullable' required: - type - attributes patchIndividualVirtualDebitCard: title: Patch Individual Virtual Debit Card type: object properties: type: type: string enum: - individualVirtualDebitCard attributes: type: object properties: tags: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchTransactionTags/properties/attributes/properties/tags limits: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessDebitCard/properties/attributes/properties/limits defaultFundingAccountId: $ref: '#/components/schemas/idNullable' required: - type - attributes patchBusinessDebitCard: title: Patch Business Debit Card type: object properties: type: type: string enum: - businessDebitCard attributes: type: object properties: tags: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchTransactionTags/properties/attributes/properties/tags shippingAddress: $ref: '#/components/schemas/addressNullable' address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email design: type: string limits: type: object properties: dailyWithdrawal: type: integer dailyPurchase: type: integer monthlyWithdrawal: type: integer monthlyPurchase: type: integer defaultFundingAccountId: $ref: '#/components/schemas/idNullable' required: [] required: - type - attributes patchBusinessVirtualDebitCard: title: Patch Business Virtual Debit Card type: object properties: type: type: string enum: - businessVirtualDebitCard attributes: type: object properties: tags: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchTransactionTags/properties/attributes/properties/tags address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email limits: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessDebitCard/properties/attributes/properties/limits defaultFundingAccountId: $ref: '#/components/schemas/idNullable' required: [] required: - type - attributes patchBusinessCreditCard: title: Patch Business Credit Card type: object properties: type: type: string enum: - businessCreditCard attributes: type: object properties: tags: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchTransactionTags/properties/attributes/properties/tags shippingAddress: $ref: '#/components/schemas/addressNullable' address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email design: type: string limits: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessDebitCard/properties/attributes/properties/limits defaultFundingAccountId: $ref: '#/components/schemas/idNullable' required: [] required: - type - attributes patchBusinessVirtualCreditCard: title: Patch Business Virtual Credit Card type: object properties: type: type: string enum: - businessVirtualCreditCard attributes: type: object properties: tags: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchTransactionTags/properties/attributes/properties/tags address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email limits: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessDebitCard/properties/attributes/properties/limits defaultFundingAccountId: $ref: '#/components/schemas/idNullable' required: [] required: - type - attributes type: object properties: data: oneOf: - $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchIndividualDebitCard - $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchIndividualVirtualDebitCard - $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessDebitCard - $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessVirtualDebitCard - $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessCreditCard - $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessVirtualCreditCard required: - data ApproveAuthorizationRequestByIdRequest: title: ApproveAuthorizationRequest type: object properties: data: $ref: >- #/paths/~1authorization-requests~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/approveAuthorizationRequest DeclineAuthorizationRequestViaApiRequest: title: DeclineAuthorizationRequest type: object properties: data: $ref: >- #/paths/~1authorization-requests~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/declineAuthorizationRequest CreateRewardViaApiRequest: definitions: createRewardRelationships: type: object properties: fundingAccount: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account receivingAccount: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account rewardedTransaction: type: object properties: data: type: object properties: type: type: string default: transaction id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data required: - receivingAccount type: object properties: data: type: object properties: type: type: string default: reward attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags description: type: string maxLength: 50 amount: type: integer minimum: 1 idempotencyKey: type: string minLength: 1 maxLength: 255 required: - amount - description relationships: $ref: >- #/paths/~1rewards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createRewardRelationships required: - type - attributes - relationships CreateFeeViaApiRequest: definitions: createFeeRelationships: type: object properties: account: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account required: - account type: object data: type: object properties: type: type: string enum: - fee default: fee attributes: type: object properties: tags: type: object maxProperties: 15 description: type: string maxLength: 50 amount: type: integer minimum: 1 idempotencyKey: type: string minLength: 1 maxLength: 255 required: - amount - description relationships: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createFeeRelationships required: - type - attributes - relationships CreateCheckDepositViaApiRequest: definitions: createCheckDepositRelationships: type: object properties: account: type: object properties: data: type: object properties: id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id type: type: string required: - id - type required: - data required: - account type: object properties: data: type: object properties: type: type: string enum: - checkDeposit default: checkDeposit attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags description: type: string minLength: 1 maxLength: 50 amount: type: integer minimum: 1 idempotencyKey: type: string minLength: 1 maxLength: 255 required: - amount - description relationships: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships required: - type - attributes - relationships UpdateCheckDepositByIdRequest: title: Patch Check Deposit definitions: patchCheckDeposit: title: Patch Check Deposit type: object properties: type: type: string default: checkDeposit attributes: type: object properties: tags: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchTransactionTags/properties/attributes/properties/tags amount: type: integer minimum: 1 required: - type - attributes type: object properties: data: $ref: >- #/paths/~1check-deposits~1%7BcheckDepositId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchCheckDeposit required: - data CreateOrgApiTokenViaApiRequest: title: Create API Token type: object properties: data: type: object properties: type: type: string default: apiToken attributes: type: object properties: description: type: string scope: type: string expiration: type: string format: date-time sourceIp: type: string resources: type: array minItems: 1 items: type: object properties: type: type: string enum: - card - account ids: type: array items: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - description - expiration required: - type - attributes CreateCustomerTokenViaApiRequest: type: object properties: data: type: object properties: type: type: string default: customerToken attributes: type: object properties: scope: type: string verificationToken: type: string jwtToken: type: string expiresIn: type: integer verificationCode: type: string resources: type: array minItems: 1 items: type: object properties: type: type: string enum: - card - account ids: type: array items: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id upgradableScope: type: string CreateCustomerTokenVerificationViaApiRequest: type: object properties: data: type: object properties: type: type: string default: customerTokenVerification attributes: type: object properties: channel: type: string enum: - sms - call phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone appHash: type: string minLength: 11 maxLength: 11 language: type: string enum: - en - af - ar - ca - zh - zh-CN - zh-HK - hr - cs - da - nl - en-GB - et - fi - fr - de - el - he - hi - hu - id - it - ja - kn - ko - ms - mr - nb - pl - pt-BR - pt - ro - ru - sk - es - sv - tl - te - th - tr - vi required: - channel required: - type - attributes CreateWebhookViaApiRequest: title: createWebhook type: object properties: data: type: object properties: type: type: string default: webhook attributes: type: object properties: label: type: string url: type: string token: type: string contentType: type: string enum: - Json - JsonAPI deliveryMode: type: string includeResources: type: boolean subscriptionType: type: string enum: - All - OnlyAuthorizationRequest required: - label - url - token - contentType - deliveryMode UpdateWebhookViaApiRequest: type: object properties: data: type: object properties: type: type: string attributes: type: object properties: tags: type: object UpdateTransactionViaApiRequest: title: Patch Transaction definitions: accountRelationship: type: object properties: data: type: object properties: type: type: string enum: - account - depositAccount - creditAccount - batchAccount id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data patchTransactionTags: title: Patch Transaction type: object properties: type: type: string default: transaction attributes: type: object properties: tags: type: object maxProperties: 15 required: - tags required: - type - attributes patchBookTransaction: title: Patch Book Transaction type: object properties: type: type: string default: bookTransaction attributes: type: object properties: tags: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchTransactionTags/properties/attributes/properties/tags summary: type: string relationships: type: object properties: account: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship required: - account required: - type - attributes patchChargebackTransaction: title: Patch Chargeback Transaction type: object properties: type: type: string default: chargebackTransaction attributes: type: object properties: tags: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchTransactionTags/properties/attributes/properties/tags summary: type: string relationships: type: object properties: account: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship required: - account required: - type - attributes type: object properties: data: oneOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchTransactionTags - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBookTransaction - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchChargebackTransaction required: - data CreateARepaymentViaApiRequest: definitions: CreateAchRepayment: title: Create ACH Repayment type: object properties: type: type: string default: achRepayment attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags description: type: string minLength: 1 maxLength: 10 amount: type: integer minimum: 1 addenda: type: string minLength: 1 maxLength: 80 idempotencyKey: type: string minLength: 1 maxLength: 255 sameDay: type: boolean required: - amount - description relationships: type: object properties: account: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account creditAccount: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account counterparty: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account required: - account - creditAccount - counterparty required: - type - attributes - relationships CreateBookRepayment: title: Create Book Repayment type: object properties: type: type: string default: bookRepayment attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags description: type: string minLength: 1 maxLength: 80 amount: type: integer minimum: 1 transactionSummaryOverride: type: string minLength: 1 maxLength: 100 idempotencyKey: type: string minLength: 1 maxLength: 255 required: - amount - description relationships: type: object properties: account: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account creditAccount: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account counterpartyAccount: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account required: - account - creditAccount - counterpartyAccount required: - type - attributes - relationships type: object properties: data: oneOf: - $ref: >- #/paths/~1repayments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateAchRepayment - $ref: >- #/paths/~1repayments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBookRepayment CreateCheckPaymentViaApiRequest: definitions: relationships: type: object properties: account: type: object properties: data: type: object properties: type: type: string enum: - account - depositAccount id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id customer: type: object properties: data: type: object properties: type: type: string enum: - businessCustomer - individualCustomer id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data required: - account - customer checkPayment: title: Check Payment type: object properties: type: type: string default: checkPayment attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags description: type: string minLength: 1 maxLength: 50 counterparty: type: object properties: name: type: string maxLength: 40 address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address counterpartyMoved: type: boolean required: - name - address amount: type: integer minimum: 1 idempotencyKey: type: string minLength: 1 maxLength: 255 sendDate: type: string format: date memo: type: string required: - counterparty - amount - idempotencyKey - description relationships: $ref: >- #/paths/~1check-payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/relationships required: - type - attributes - relationships type: object properties: data: $ref: >- #/paths/~1check-payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/checkPayment required: - data ApproveCheckPaymentByIdRequest: title: ApproveCheckPaymentRequest type: object properties: data: type: object properties: type: type: string default: additionalVerification ReturnCheckPaymentByIdRequest: title: ReturnCheckPaymentRequest type: object properties: data: type: object properties: type: type: string default: checkPaymentReturn attributes: type: object properties: reason: type: string enum: - InsufficientFunds - AccountClosed - AlteredCheck - ForgedSignature - PostdatedCheck - StopPaymentOrder - UnauthorizedDebit - WrongAmount - DuplicatePayment - MissingSignature - IrregularEndorsement - Other StopPaymentCreateRequest: definitions: relationships: type: object properties: account: type: object properties: data: type: object properties: type: type: string enum: - account - depositAccount - financialBusinessFBOAccount id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data required: - account stopPayment: title: Stop Payment type: object properties: type: type: string default: stopPayment attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags amount: type: integer minimum: 1 checkNumber: type: string maxLength: 12 idempotencyKey: type: string minLength: 1 maxLength: 255 required: - amount - checkNumber relationships: $ref: >- #/paths/~1stop-payments/post/requestBody/content/application~1json/schema/definitions/relationships required: - type - attributes - relationships type: object properties: data: $ref: >- #/paths/~1stop-payments/post/requestBody/content/application~1json/schema/definitions/stopPayment required: - data GetApplicationByIdResponse: title: UnitApplicationResponseWithIncluded type: object properties: data: $ref: >- #/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data included: $ref: >- #/paths/~1transactions/get/responses/200/content/application~1vnd.api%2Bjson/schema/properties/included CancelApplicationByIdResponse: title: UnitCancelApplicationResponse type: object properties: data: $ref: >- #/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data included: type: array items: $ref: >- #/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/included/items GetListApplicationsFromApiResponse: title: UnitError type: object GetListApplicationsFromApi200Response: title: UnitListApplicationsResponse type: object properties: data: type: array items: $ref: >- #/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data meta: type: object properties: pagination: type: object properties: limit: type: integer offset: type: integer total: type: integer CreateApplicationViaApiResponse: title: UnitCreateApplicationResponse type: object properties: data: title: Application definitions: powerOfAttorneyAgent: title: PowerOfAttorneyAgent type: object properties: status: type: string fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone ssn: type: string pattern: ^\d{9}$ passport: type: string nationality: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality matriculaConsular: type: string address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address dateOfBirth: type: string format: date evaluationId: type: string evaluationFlags: type: array items: type: string maskedSSN: type: string pattern: ^\*{5}\d{4}$ maskedPassport: type: string maskedMatriculaConsular: type: string idTheftScore: type: integer required: - status - fullName officer: title: Officer type: object properties: title: type: string enum: - President - CEO - COO - CFO - BenefitsAdministrationOfficer - CIO - VP - AVP - Treasurer - Secretary - Controller - Manager - Partner - Member status: type: string fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone ssn: type: string pattern: ^\d{9}$ passport: type: string nationality: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality matriculaConsular: type: string address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address dateOfBirth: type: string format: date evaluationId: type: string evaluationFlags: type: array items: type: string maskedSSN: type: string pattern: ^\*{5}\d{4}$ maskedPassport: type: string maskedMatriculaConsular: type: string idTheftScore: type: integer occupation: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/occupation annualIncome: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/annualIncome sourceOfIncome: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/sourceOfIncome beneficialOwner: title: Beneficial Owner type: object properties: status: type: string fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone ssn: type: string pattern: ^\d{9}$ passport: type: string nationality: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality matriculaConsular: type: string address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address dateOfBirth: type: string format: date evaluationId: type: string percentage: type: integer minimum: 0 maximum: 100 evaluationFlags: type: array items: type: string maskedSSN: type: string pattern: ^\*{5}\d{4}$ maskedPassport: type: string maskedMatriculaConsular: type: string idTheftScore: type: integer evaluationCodes: type: array items: type: string occupation: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/occupation annualIncome: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/annualIncome sourceOfIncome: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/sourceOfIncome applicationRelationships: title: applicationRelationships type: object properties: org: $ref: >- #/paths/~1customers~1%7BcustomerId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/relationships/properties/org customer: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account documents: title: documentsRelationship type: object properties: data: type: array items: type: object properties: type: type: string default: document id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id additionalProperties: true required: - data applicationForm: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account trustees: type: object properties: data: type: array items: type: object properties: type: type: string default: trustee id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id beneficiaries: type: object properties: data: type: array items: type: object properties: type: type: string default: beneficiary id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id beneficialOwners: type: object properties: data: type: array items: type: object properties: type: type: string default: beneficialOwner id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id BusinessApplication: title: BusinessApplication type: object allOf: - $ref: >- #/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags createdAt: type: string format: date-time updatedAt: type: string format: date-time status: $ref: >- #/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/TrustApplication/allOf/1/properties/attributes/properties/status message: type: string evaluationOutcome: type: string evaluationId: type: string evaluationEntityId: type: string name: type: string dba: type: string nullable: true ein: type: string pattern: ^\d{9}$ entityType: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/entityType dateOfIncorporation: type: string format: date stateOfIncorporation: $ref: >- #/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/TrustApplication/allOf/1/properties/attributes/properties/stateOfIncorporation purpose: type: string phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address contact: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/contact officer: $ref: >- #/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/officer ip: type: string website: type: string beneficialOwners: type: array items: $ref: >- #/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/beneficialOwner decisionMethod: type: string enum: - Manually - Automatically decisionUserId: type: string decisionReason: type: string decisionDateTime: type: string format: date-time riskRate: type: string enum: - low - medium - high evaluationFlags: type: array items: type: string ipLocationDetails: type: object phoneLocationDetails: type: object archived: type: boolean industry: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/industry annualRevenue: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/annualRevenue numberOfEmployees: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/numberOfEmployees cashFlow: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/cashFlow yearOfIncorporation: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/yearOfIncorporation countriesOfOperation: type: array items: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality minItems: 1 stockSymbol: type: string businessVertical: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/businessVertical required: - createdAt - status - name - entityType - stateOfIncorporation - contact - officer - beneficialOwners relationships: $ref: >- #/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/applicationRelationships required: - id - type - attributes IndividualApplication: title: IndividualApplication type: object allOf: - $ref: >- #/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags createdAt: type: string format: date-time updatedAt: type: string format: date-time status: $ref: >- #/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/TrustApplication/allOf/1/properties/attributes/properties/status message: type: string evaluationOutcome: type: string evaluationId: type: string evaluationEntityId: type: string fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone ssn: type: string pattern: ^\d{9}$ passport: type: string nationality: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality matriculaConsular: type: string address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address dateOfBirth: type: string format: date dba: type: string ein: type: string pattern: ^\d{9}$ ip: type: string soleProprietorship: type: boolean decisionMethod: type: string enum: - Manually - Automatically decisionUserId: type: string decisionReason: type: string decisionDateTime: type: string format: date-time riskRate: type: string enum: - low - medium - high evaluationFlags: type: array items: type: string evaluationScores: type: object ipLocationDetails: type: object phoneLocationDetails: type: object maskedSSN: type: string pattern: ^\*{5}\d{4}$ maskedPassport: type: string maskedMatriculaConsular: type: string jwtSubject: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent/properties/jwtSubject archived: type: boolean powerOfAttorneyAgent: $ref: >- #/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/powerOfAttorneyAgent industry: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/industry idTheftScore: type: integer occupation: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/occupation annualIncome: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/annualIncome sourceOfIncome: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/sourceOfIncome annualRevenue: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchSoleProprietorApplication/properties/attributes/properties/annualRevenue numberOfEmployees: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchSoleProprietorApplication/properties/attributes/properties/numberOfEmployees businessVertical: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/businessVertical website: type: string required: - createdAt - status - fullName relationships: $ref: >- #/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/applicationRelationships required: - id - type - attributes TrustApplication: title: TrustApplication type: object allOf: - $ref: >- #/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags createdAt: type: string format: date-time updatedAt: type: string format: date-time status: type: string enum: - AwaitingDocuments - PendingReview - Approved - Denied - Pending - Canceled message: type: string evaluationOutcome: type: string evaluationId: type: string evaluationEntityId: type: string name: type: string dateOfIncorporation: type: string format: date stateOfIncorporation: type: string pattern: >- ^((A[LKSZR])|(C[AOT])|(D[EC])|(F[ML])|(G[AU])|(HI)|(I[DLNA])|(K[SY])|(LA)|(M[EHDAINSOT])|(N[EVHJMYCD])|(MP)|(O[HKR])|(P[WAR])|(RI)|(S[CD])|(T[NX])|(UT)|(V[TIA])|(W[AVIY]))$ revocability: type: string enum: - Revocable - Irrevocable sourceOfFunds: type: string enum: - Inheritance - Salary - Savings - InvestmentReturns - Gifts taxId: type: string contact: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateTrustApplication/properties/attributes/properties/contact trustees: type: array items: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateTrustApplication/properties/attributes/properties/trustees/items grantor: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateTrustApplication/properties/attributes/properties/grantor ip: type: string decisionMethod: type: string enum: - Manually - Automatically decisionUserId: type: string decisionReason: type: string decisionDateTime: type: string format: date-time riskRate: type: string enum: - low - medium - high evaluationFlags: type: array items: type: string ipLocationDetails: type: object phoneLocationDetails: type: object archived: type: boolean required: - createdAt - status - name - stateOfIncorporation - contact relationships: $ref: >- #/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/applicationRelationships required: - id - type - attributes type: object properties: id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id type: type: string discriminator: propertyName: type mapping: individualApplication: '#/definitions/IndividualApplication' businessApplication: '#/definitions/BusinessApplication' trustApplication: '#/definitions/TrustApplication' included: type: array items: title: Application Document Document type: object properties: type: type: string default: document id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id attributes: type: object properties: description: type: string documentType: type: string status: type: string nationality: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality ssn: type: string pattern: ^\d{9}$ passport: type: string matriculaConsular: type: string name: type: string address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address dateOfIncorporation: type: string format: date stateOfIncorporation: type: string dateOfBirth: type: string format: date ein: type: string pattern: ^\d{9}$ reasonCode: type: string reason: type: string evaluationId: type: string frontDocumentId: type: string backDocumentId: type: string frontDocumentStoreId: type: string backDocumentStoreId: type: string required: - status required: - type - id - attributes GetListApplicationFormsViaApiResponse: title: UnitApplicationFormsListResponse type: object properties: data: type: array items: $ref: >- #/paths/~1application-forms/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data CreateApplicationFormViaApiResponse: title: UnitApplicationFormResponse type: object properties: data: title: Application Form definitions: applicationFormRelationships: title: applicationFormRelationships type: object properties: application: type: object properties: data: type: object properties: id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id type: type: string enum: - application required: [] ApplicationFormPrefill: title: Application Form Prefilled type: object properties: applicationType: type: string enum: - Individual - Business - SoleProprietorship fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName ssn: type: string pattern: ^\d{9}$ passport: type: string nationality: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality dateOfBirth: type: string format: date email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email name: type: string minLength: 1 maxLength: 255 stateOfIncorporation: type: string minLength: 2 maxLength: 2 entityType: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/entityType contact: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/contact officer: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer beneficialOwners: type: array items: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createBeneficialOwner website: type: string phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address dba: type: string minLength: 1 maxLength: 255 ein: type: string pattern: ^\d{9}$ jwtSubject: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent/properties/jwtSubject industry: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/industry ApplicationFormSettingsOverride: type: object properties: redirectUrl: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/attributes/properties/link privacyPolicyUrl: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/attributes/properties/link electronicDisclosuresUrl: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/attributes/properties/link depositTermsUrl: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/attributes/properties/link clientTermsUrl: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/attributes/properties/link cardholderTermsUrl: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/attributes/properties/link cashAdvancedTermsUrl: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/attributes/properties/link debitCardDisclosureUrl: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/attributes/properties/link additionalDisclosures: type: array items: type: object properties: title: type: string url: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/attributes/properties/link type: object properties: type: type: string default: applicationForm id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email url: type: string stage: type: string enum: - ChooseBusinessOrIndividual - EnterIndividualInformation - IndividualPhoneVerification - IndividualApplicationCreated - EnterBusinessInformation - EnterBusinessAdditionalInformation - EnterOfficerInformation - BusinessPhoneVerification - EnterBeneficialOwnersInformation - BusinessApplicationCreated - EnterSoleProprietorshipInformation - EnterSoleProprietorshipBusinessInformation - SoleProprietorshipPhoneVerification - SoleProprietorshipApplicationCreated applicantDetails: $ref: >- #/paths/~1application-forms/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/ApplicationFormPrefill settingsOverride: $ref: >- #/paths/~1application-forms/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/ApplicationFormSettingsOverride allowedApplicationTypes: type: array items: type: string enum: - Individual - Business - SoleProprietorship required: - url relationships: $ref: >- #/paths/~1application-forms/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/applicationFormRelationships required: - type - id - attributes GetListOfDocumentsViaApiResponse: title: UnitListDocumentsResponse type: object properties: data: type: array items: $ref: >- #/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/included/items CreateADocumentForAnApplicationViaApiResponse: title: UnitDocumentResponse type: object properties: data: $ref: >- #/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/included/items DownloadADocumentViaApiResponse: type: string format: binary DownloadADocumentBackSideViaApiResponse: type: string format: binary GetApplicationFormByIdResponse: title: UnitApplicationFormResponseWithIncluded type: object properties: data: $ref: >- #/paths/~1application-forms/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data included: $ref: >- #/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data GetListAccountsFromApiResponse: title: UnitAccountsListResponse type: object properties: data: type: array items: title: Account Document definitions: DepositAccount: title: Deposit Account type: object allOf: - $ref: >- #/paths/~1accounts/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags createdAt: type: string format: date-time name: type: string depositProduct: type: string routingNumber: type: string pattern: ^\d{9}$ accountNumber: type: string pattern: ^\d{10,12}$ secondaryAccountNumber: type: object properties: routingNumber: type: string pattern: ^\d{9}$ accountNumber: type: string pattern: ^\d{10,12}$ required: - routingNumber - accountNumber currency: type: string default: USD balance: type: integer overdraftLimit: type: integer minimum: 0 hold: type: integer available: type: integer status: enum: - Open - Closed - Frozen type: string closeReason: type: string enum: - ByCustomer - Fraud fraudReason: type: string enum: - ACHActivity - CardActivity - CheckActivity - ApplicationHistory - AccountActivity - ClientIdentified - IdentityTheft - LinkedToFraudulentCustomer closeReasonText: type: string maxLength: 255 freezeReason: type: string maskedAccountNumber: type: string pattern: ^\*{6,8}\d{4}$ isOverdrawnWithinLimit: type: boolean dacaStatus: enum: - Activated - Entered type: string updatedAt: type: string format: date-time required: - createdAt - name - depositProduct - routingNumber - currency - balance - hold - available - tags - status relationships: title: depositAccountRelationships type: object properties: customer: $ref: >- #/paths/~1customers/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items/definitions/customerLinkage additionalProperties: true required: - attributes - relationships CreditAccount: title: Credit Account type: object allOf: - $ref: >- #/paths/~1accounts/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags createdAt: type: string format: date-time name: type: string creditTerms: type: string currency: type: string default: USD balance: type: integer hold: type: integer available: type: integer status: enum: - Open - Closed - Frozen type: string closeReason: type: string enum: - ByCustomer - Fraud - Overdue fraudReason: type: string enum: - ACHActivity - CardActivity - CheckActivity - ApplicationHistory - AccountActivity - ClientIdentified - IdentityTheft - LinkedToFraudulentCustomer closeReasonText: type: string maxLength: 255 freezeReason: type: string creditLimit: type: integer minimum: 0 updatedAt: type: string format: date-time required: - createdAt - name - creditTerms - currency - balance - hold - available - tags - status - creditLimit relationships: title: creditAccountRelationships type: object properties: customer: $ref: >- #/paths/~1customers/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items/definitions/customerLinkage additionalProperties: true required: - customer required: - attributes - relationships orgGeneralLedgerAccount: title: Org General Ledger Account type: object properties: type: type: string default: orgGeneralLedgerAccount id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags createdAt: type: string format: date-time updatedAt: type: string format: date-time name: type: string orgId: type: string currency: type: string default: USD balance: type: integer hold: type: integer available: type: integer category: type: string enum: - Asset - Liability status: enum: - Open - Closed type: string required: - createdAt - name - balance - hold - available - category - currency glAccount: title: General Ledger Account type: object properties: type: type: string default: glAccount id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id attributes: type: object properties: createdAt: type: string format: date-time updatedAt: type: string format: date-time name: type: string currency: type: string default: USD balance: type: integer hold: type: integer available: type: integer category: type: string enum: - Asset - Liability status: enum: - Open - Closed type: string closeReason: enum: - ByCustomer - Fraud type: string fraudReason: type: string enum: - ACHActivity - CardActivity - CheckActivity - ApplicationHistory - AccountActivity - ClientIdentified - IdentityTheft - LinkedToFraudulentCustomer required: - createdAt - name - balance - hold - available - category - currency batchAccount: title: Batch Account type: object properties: type: type: string default: batchAccount id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id attributes: type: object properties: createdAt: type: string format: date-time name: type: string depositProduct: type: string currency: type: string default: USD routingNumber: type: string pattern: ^\d{9}$ accountNumber: type: string pattern: ^\d{10,12}$ balance: type: integer hold: type: integer available: type: integer status: enum: - Open - Closed type: string closeReason: enum: - ByCustomer - Fraud type: string fraudReason: type: string enum: - ACHActivity - CardActivity - CheckActivity - ApplicationHistory - AccountActivity - ClientIdentified - IdentityTheft - LinkedToFraudulentCustomer maskedAccountNumber: type: string pattern: ^\*{6,8}\d{4}$ required: - createdAt - name - depositProduct - currency - routingNumber - balance - hold - available relationships: type: object properties: org: $ref: >- #/paths/~1customers~1%7BcustomerId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/relationships/properties/org required: - org type: object properties: id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id type: type: string discriminator: propertyName: type mapping: depositAccount: '#/definitions/DepositAccount' creditAccount: '#/definitions/CreditAccount' included: type: array items: $ref: >- #/paths/~1customers/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items meta: $ref: >- #/paths/~1applications/get/responses/200/content/application~1vnd.api%2Bjson/schema/properties/meta GetAccountByIdResponse: title: UnitAccountResponseWithIncluded type: object properties: data: $ref: >- #/paths/~1accounts/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items included: type: array items: $ref: >- #/paths/~1customers/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items UpdateAccountViaApiResponse: title: UnitAccountResponse type: object properties: data: $ref: >- #/paths/~1accounts/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items GetAccountLimitsByIdResponse: title: UnitGetAccountLimitsResponse type: object properties: data: type: object properties: type: type: string id: type: string attributes: type: object properties: card: type: object properties: limits: type: object properties: dailyWithdrawal: type: number dailyDeposit: type: number dailyPurchase: type: number dailyCardTransaction: type: number totalsDaily: type: object properties: withdrawal: type: number deposit: type: number purchase: type: number cardTransaction: type: number GetListAccountEndofdayBalancesHistoryFromApiResponse: title: UnitGetAccountEndOfDayListResponse type: object properties: data: title: Account End Of Day Resource definitions: relationships: type: object properties: customer: type: object properties: data: type: object properties: type: type: string default: customer id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data account: type: object properties: data: type: object properties: type: type: string default: account id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data required: - account type: object properties: type: type: string enum: - accountEndOfDay id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id attributes: type: object properties: date: type: string format: date balance: type: integer hold: type: integer available: type: integer overdraftLimit: type: integer required: - date - balance - hold - available relationships: $ref: >- #/paths/~1account-end-of-day/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/relationships required: - type - id - relationships - attributes UpdateCustomerViaApiResponse: title: UnitCustomerResponse type: object properties: data: $ref: >- #/paths/~1customers/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items GetListCustomersApiListResponse: title: UnitCustomersListResponse type: object properties: data: type: array items: title: Customer definitions: customerRelationships: title: customerRelationships type: object properties: org: $ref: >- #/paths/~1customers~1%7BcustomerId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/relationships/properties/org application: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account additionalProperties: true IndividualCustomer: title: IndividualCustomer type: object allOf: - $ref: >- #/paths/~1customers/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags createdAt: type: string format: date-time fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone ssn: type: string pattern: ^\d{9}$ passport: type: string nationality: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality matriculaConsular: type: string address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address dateOfBirth: type: string format: date ein: type: string dba: type: string soleProprietorship: type: boolean default: 'false' riskRate: type: string enum: - low - medium - high maskedSSN: type: string pattern: ^\*{5}\d{4}$ maskedPassport: type: string maskedMatriculaConsular: type: string authorizedUsers: type: array items: $ref: >- #/paths/~1customers~1%7BcustomerId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/updateTrustCustomer/properties/attributes/properties/authorizedUsers/items jwtSubject: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent/properties/jwtSubject status: type: string enum: - Active - Archived archiveReason: type: string enum: - Inactive - FraudACHActivity - FraudCardActivity - FraudCheckActivity - FraudApplicationHistory - FraudAccountActivity - FraudClientIdentified - FraudLinkedToFraudulentCustomer required: - createdAt - fullName - status relationships: $ref: >- #/paths/~1customers/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items/definitions/customerRelationships BusinessCustomer: title: BusinessCustomer type: object allOf: - $ref: >- #/paths/~1customers/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags createdAt: type: string format: date-time name: type: string dba: type: string ein: type: string pattern: ^\d{9}$ entityType: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/entityType dateOfIncorporation: type: string format: date stateOfIncorporation: type: string purpose: type: string phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address contact: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/contact riskRate: type: string enum: - low - medium - high authorizedUsers: type: array items: $ref: >- #/paths/~1customers~1%7BcustomerId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/updateTrustCustomer/properties/attributes/properties/authorizedUsers/items status: type: string enum: - Active - Archived archiveReason: type: string enum: - Inactive - FraudACHActivity - FraudCardActivity - FraudCheckActivity - FraudApplicationHistory - FraudAccountActivity - FraudClientIdentified - FraudLinkedToFraudulentCustomer required: - name - entityType - stateOfIncorporation - contact - status relationships: $ref: >- #/paths/~1customers/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items/definitions/customerRelationships TrustCustomer: title: TrustCustomer type: object allOf: - $ref: >- #/paths/~1customers/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags createdAt: type: string format: date-time name: type: string stateOfIncorporation: type: string contact: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateTrustApplication/properties/attributes/properties/contact revocability: $ref: >- #/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/TrustApplication/allOf/1/properties/attributes/properties/revocability sourceOfFunds: $ref: >- #/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/TrustApplication/allOf/1/properties/attributes/properties/sourceOfFunds taxId: type: string riskRate: type: string enum: - low - medium - high authorizedUsers: type: array items: $ref: >- #/paths/~1customers~1%7BcustomerId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/updateTrustCustomer/properties/attributes/properties/authorizedUsers/items status: type: string enum: - Active - Archived archiveReason: type: string enum: - Inactive - FraudACHActivity - FraudCardActivity - FraudCheckActivity - FraudApplicationHistory - FraudAccountActivity - FraudClientIdentified - FraudLinkedToFraudulentCustomer required: - name - stateOfIncorporation - contact - status relationships: $ref: >- #/paths/~1customers/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items/definitions/customerRelationships customerLinkage: type: object properties: data: type: object properties: type: type: string enum: - customer - businessCustomer - individualCustomer id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data type: object properties: id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id type: type: string discriminator: propertyName: type mapping: individualCustomer: '#/definitions/IndividualCustomer' businessCustomer: '#/definitions/BusinessCustomer' trustCustomer: '#/definitions/TrustCustomer' meta: $ref: >- #/paths/~1applications/get/responses/200/content/application~1vnd.api%2Bjson/schema/properties/meta GetListPaymentsFromApiResponse: title: UnitPaymentsListResponse type: object properties: data: type: array items: $ref: >- #/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data included: $ref: >- #/paths/~1transactions/get/responses/200/content/application~1vnd.api%2Bjson/schema/properties/included meta: $ref: >- #/paths/~1applications/get/responses/200/content/application~1vnd.api%2Bjson/schema/properties/meta GetPaymentByIdResponse: title: UnitPaymentResponseWithIncluded type: object properties: data: title: Payment Resource definitions: paymentRelationships: type: object properties: account: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account customer: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account customers: type: object properties: data: type: array items: type: object properties: id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id type: type: string default: org counterparty: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account counterpartyAccount: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account transaction: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account recurringPayment: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account additionalProperties: true AchPayment: title: ACH Payment type: object allOf: - $ref: >- #/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags description: type: string minLength: 1 maxLength: 50 createdAt: type: string format: date-time amount: type: integer minimum: 1 direction: type: string enum: - Credit - Debit addenda: type: string minLength: 1 maxLength: 80 counterparty: $ref: >- #/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/counterparty status: type: string enum: - Pending - Rejected - Clearing - Sent - Canceled - Returned settlementDate: type: string format: date reason: type: string expectedCompletionDate: type: string format: date secCode: type: string traceNumber: type: string sameDay: type: boolean counterpartyVerificationMethod: type: string clearingDaysOverride: type: integer required: - createdAt - status - description - amount - direction relationships: $ref: >- #/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/paymentRelationships required: - type - id - attributes - relationships BookPayment: title: Book Payment type: object allOf: - $ref: >- #/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags description: type: string minLength: 1 maxLength: 80 createdAt: type: string format: date-time amount: type: integer minimum: 1 direction: type: string enum: - Credit - Debit status: type: string enum: - Pending - Rejected - Clearing - Sent - Canceled - Returned transactionSummaryOverride: type: string reason: type: string required: - createdAt - amount - direction - description - status relationships: $ref: >- #/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/paymentRelationships required: - type - id - attributes - relationships WirePayment: title: Wire Payment type: object allOf: - $ref: >- #/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data - type: object properties: attributes: type: object properties: description: type: string minLength: 1 maxLength: 50 createdAt: type: string format: date-time amount: type: integer minimum: 1 direction: type: string enum: - Credit counterparty: $ref: >- #/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/wireCounterparty status: type: string enum: - Pending - Rejected - Clearing - Sent - Canceled - Returned settlementDate: type: string format: date reason: type: string imadOmad: type: object properties: imad: type: string omad: type: string required: - createdAt - amount - direction - description - status relationships: $ref: >- #/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/paymentRelationships required: - type - id - attributes - relationships BillPayment: title: Bill Payment type: object allOf: - $ref: >- #/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data - type: object properties: attributes: type: object properties: description: type: string minLength: 1 maxLength: 50 createdAt: type: string format: date-time amount: type: integer minimum: 1 direction: type: string enum: - Credit - Debit status: type: string enum: - Initialized - Pending - Rejected - Clearing - Sent - Canceled - Returned reason: type: string required: - createdAt - amount - direction - description - status relationships: $ref: >- #/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/paymentRelationships required: - type - id - attributes - relationships pushToCardPayment: title: Push To Card Payment Response type: object allOf: - $ref: >- #/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags description: type: string minLength: 1 createdAt: type: string format: date-time amount: type: integer minimum: 1 direction: type: string enum: - Debit - Credit status: type: string enum: - Pending - Rejected - Sent reason: type: string astraRoutineId: type: string required: - createdAt - amount - direction - description - status relationships: $ref: >- #/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/paymentRelationships required: - type - id - attributes - relationships counterparty: title: Counterparty type: object properties: routingNumber: type: string pattern: ^\d{9}$ accountNumber: type: string pattern: ^\d{1,17}$ accountType: type: string enum: - Checking - Savings - Loan name: type: string minLength: 1 maxLength: 50 required: - routingNumber - accountNumber - accountType - name wireCounterparty: title: WireCounterparty type: object properties: routingNumber: type: string pattern: ^\d{9}$ accountNumber: type: string maxLength: 17 name: type: string minLength: 1 maxLength: 50 address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address required: - routingNumber - accountNumber - address - name astra: title: AstraPushToCardConfiguration type: object properties: authToken: type: string minLength: 1 debitFeePercent: type: number institutionId: type: string minLength: 1 destinationCardId: type: string minLength: 1 routingNumber: type: string minLength: 1 accountNumber: type: string minLength: 1 accountName: type: string minLength: 1 referenceId: type: string minLength: 1 maxLength: 80 required: - debitFeePercent - institutionId - destinationCardId - routingNumber - accountNumber - referenceId additionalProperties: false type: object properties: type: type: string id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id discriminator: propertyName: type mapping: achPayment: '#/definitions/AchPayment' bookPayment: '#/definitions/BookPayment' wirePayment: '#/definitions/WirePayment' billPayment: '#/definitions/BillPayment' included: $ref: >- #/paths/~1transactions/get/responses/200/content/application~1vnd.api%2Bjson/schema/properties/included UpdatePaymentViaApiResponse: title: UnitPaymentResponse type: object properties: data: $ref: >- #/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data GetReceivedPaymentsListFromApiResponse: title: UnitReceivedPaymentListResponse type: object properties: data: type: array items: $ref: >- #/paths/~1received-payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data included: $ref: >- #/paths/~1transactions/get/responses/200/content/application~1vnd.api%2Bjson/schema/properties/included meta: $ref: >- #/paths/~1applications/get/responses/200/content/application~1vnd.api%2Bjson/schema/properties/meta GetReceivedPaymentByIdResponse: title: UnitReceivedPaymentResponseWithIncluded type: object properties: data: title: Received Payment Resource definitions: receivedPaymentRelationships: type: object properties: account: type: object properties: data: type: object properties: type: type: string default: account id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data customer: type: object properties: data: type: object properties: type: type: string enum: - businessCustomer - individualCustomer - customer id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data receivePaymentTransaction: type: object properties: data: type: object properties: type: type: string default: transaction id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data paymentAdvanceTransaction: type: object properties: data: type: object properties: type: type: string default: transaction id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data repayPaymentAdvanceTransaction: type: object properties: data: type: object properties: type: type: string default: transaction id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data additionalProperties: true required: - account - customer type: object properties: type: type: string id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags description: type: string createdAt: type: string format: date-time status: type: string enum: - Pending - Advanced - Completed - Returned amount: type: integer minimum: 1 completionDate: type: string direction: type: string enum: - Debit - Credit wasAdvanced: type: boolean isAdvanceable: type: boolean isAdvaceable: type: boolean companyName: type: string counterpartyRoutingNumber: type: string addenda: type: string traceNumber: type: string secCode: type: string minLength: 3 maxLength: 3 returnReason: type: string receivingEntityName: type: string required: - createdAt - amount - description - status - completionDate - companyName - counterpartyRoutingNumber - traceNumber - wasAdvanced - direction - secCode relationships: $ref: >- #/paths/~1received-payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/receivedPaymentRelationships included: $ref: >- #/paths/~1transactions/get/responses/200/content/application~1vnd.api%2Bjson/schema/properties/included UpdateReceivedPaymentViaApiResponse: title: UnitReceivedPaymentResponse type: object properties: data: $ref: >- #/paths/~1received-payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data GetListCounterpartiesFromApiResponse: title: UnitCounterpartiesListResponse type: object properties: data: $ref: >- #/paths/~1counterparties/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data CreateCounterpartyViaApiResponse: title: UnitCounterpartyResponse type: object properties: data: title: Counterparty Document definitions: counterpartyRelationships: title: counterpartyRelationships type: object properties: customer: type: object properties: data: type: object properties: type: type: string default: customer id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data required: - customer type: object properties: type: type: string id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags routingNumber: type: string pattern: ^\d{9}$ accountNumber: type: string pattern: ^\d{1,17}$ accountType: type: string enum: - Checking - Savings - Loan type: type: string enum: - Business - Person - Unknown name: type: string minLength: 1 maxLength: 50 bank: type: string permissions: type: string enum: - CreditOnly - DebitOnly - CreditAndDebit createdAt: type: string format: date-time required: - routingNumber - accountNumber - accountType - type - name - createdAt - permissions relationships: $ref: >- #/paths/~1counterparties/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/counterpartyRelationships GetCounterpartyByIdResponse: title: UnitCounterpartyResponse type: object properties: data: $ref: >- #/paths/~1counterparties/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data UpdateCounterpartyViaApiResponse: title: UnitCounterpartyResponse type: object properties: data: $ref: >- #/paths/~1counterparties/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data GetCounterpartyBalanceRecurringPaymentFromApiResponse: title: UnitCounterpartyResponse type: object properties: data: title: Counterparty Balance definitions: counterpartyBalanceRelationships: title: counterpartyBalanceRelationships type: object properties: counterparty: type: object properties: data: type: object properties: type: type: string default: counterparty id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data customer: type: object properties: data: type: object properties: type: type: string default: customer id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data required: - customer - counterparty type: object properties: type: type: string default: counterpartyBalance id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id attributes: type: object properties: balance: type: number available: type: number required: - balance relationships: $ref: >- #/paths/~1counterparties~1%7BcounterpartyId%7D~1balance/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/counterpartyBalanceRelationships required: - type - id - relationships GetListRecurringPaymentsFromApiResponse: title: UnitRecurringPaymentListResponse type: object properties: data: type: array items: title: Recurring Payment Resource definitions: recurringAchPaymentRelationships: type: object properties: account: type: object properties: data: type: object properties: type: type: string enum: - depositAccount - account id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data counterparty: type: object properties: data: type: object properties: type: type: string enum: - account - counterparty id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data customer: type: object properties: data: type: object properties: type: type: string enum: - businessCustomer - individualCustomer - customer id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data org: type: object properties: data: type: object properties: type: type: string id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data recurringBookPaymentRelationships: type: object properties: account: type: object properties: data: type: object properties: type: type: string enum: - depositAccount - account id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data counterpartyAccount: type: object properties: data: type: object properties: type: type: string enum: - account id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data customer: type: object properties: data: type: object properties: type: type: string enum: - businessCustomer - individualCustomer - customer id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data org: type: object properties: data: type: object properties: type: type: string id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data RecurringCreditAchPayment: title: Recurring Credit ACH Payment type: object allOf: - $ref: >- #/paths/~1recurring-payments/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags description: type: string minLength: 1 maxLength: 10 createdAt: type: string format: date-time updatedAt: type: string format: date-time amount: type: integer minimum: 1 addenda: type: string minLength: 1 maxLength: 80 status: type: string enum: - Pending - Active - Completed - Disabled schedule: $ref: >- #/paths/~1recurring-payments/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items/definitions/schedule numberOfPayments: type: integer required: - createdAt - status - description - amount - schedule - numberOfPayments relationships: $ref: >- #/paths/~1recurring-payments/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items/definitions/recurringAchPaymentRelationships required: - attributes - relationships RecurringDebitAchPayment: title: Recurring Debit ACH Payment type: object allOf: - $ref: >- #/paths/~1recurring-payments/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags description: type: string minLength: 1 maxLength: 10 createdAt: type: string format: date-time updatedAt: type: string format: date-time amount: type: integer minimum: 1 addenda: type: string minLength: 1 maxLength: 80 status: type: string enum: - Pending - Active - Completed - Disabled schedule: $ref: >- #/paths/~1recurring-payments/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items/definitions/schedule numberOfPayments: type: integer verifyCounterpartyBalance: type: boolean default: false sameDay: type: boolean default: false required: - createdAt - status - description - amount - schedule - numberOfPayments relationships: $ref: >- #/paths/~1recurring-payments/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items/definitions/recurringAchPaymentRelationships required: - attributes - relationships RecurringCreditBookPayment: title: Recurring Credit Book Payment type: object allOf: - $ref: >- #/paths/~1recurring-payments/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags description: type: string minLength: 1 maxLength: 80 createdAt: type: string format: date-time updatedAt: type: string format: date-time amount: type: integer minimum: 1 status: type: string enum: - Pending - Active - Completed - Disabled schedule: $ref: >- #/paths/~1recurring-payments/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items/definitions/schedule numberOfPayments: type: integer required: - createdAt - updatedAt - amount - description - status - schedule - numberOfPayments relationships: $ref: >- #/paths/~1recurring-payments/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items/definitions/recurringBookPaymentRelationships required: - attributes - relationships schedule: title: Schedule type: object properties: startTime: type: string format: date endTime: type: string format: date interval: type: string enum: - Monthly dayOfMonth: type: integer minimum: -5 maximum: 28 nextScheduledAction: type: string format: date totalNumberOfPayments: type: integer minimum: 1 required: - interval - nextScheduledAction type: object properties: type: type: string id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id discriminator: propertyName: type mapping: recurringCreditAchPayment: '#/definitions/RecurringCreditAchPayment' recurringDebitAchPayment: '#/definitions/RecurringDebitAchPayment' recurringCreditBookPayment: '#/definitions/RecurringCreditBookPayment' meta: $ref: >- #/paths/~1applications/get/responses/200/content/application~1vnd.api%2Bjson/schema/properties/meta CreateRecurringPaymentViaApiResponse: title: UnitRecurringPaymentResponse type: object properties: data: $ref: >- #/paths/~1recurring-payments/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items GetListOfCardsFromApiResponse: title: UnitCardResponseCardsList type: object properties: data: type: array items: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data included: type: array items: $ref: >- #/paths/~1transactions/get/responses/200/content/application~1vnd.api%2Bjson/schema/properties/included CreateACardViaApiResponse: title: UnitCardResponse type: object properties: data: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data GetCardByIdResponse: title: UnitCardResponse type: object properties: data: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data included: type: array items: $ref: >- #/paths/~1transactions/get/responses/200/content/application~1vnd.api%2Bjson/schema/properties/included UpdateCardViaApiResponse: title: UnitCardResponse type: object properties: data: title: Card Document definitions: physicalCardStatus: type: string enum: - Active - Inactive - Stolen - Lost - Frozen - ClosedByCustomer - Unknown - SuspectedFraud - ActiveForOnlineUse virtualCardStatus: type: string enum: - Active - Inactive - Stolen - Lost - Frozen - ClosedByCustomer - Unknown - SuspectedFraud cardRelationships: title: cardRelationships type: object properties: account: type: object properties: data: type: object properties: type: type: string enum: - account - depositAccount id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data customer: type: object properties: data: type: object properties: type: type: string enum: - businessCustomer - individualCustomer - customer id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data required: - account pinStatus: title: PinStatusDTO type: object properties: type: type: string attributes: type: object properties: status: type: string IndividualDebitCard: title: Individual Debit Card type: object allOf: - $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags createdAt: type: string format: date-time updatedAt: type: string format: date-time last4Digits: type: string pattern: ^\d{4}$ expirationDate: type: string pattern: ^\d{4}[-](1[012]|0[1-9])$ shippingAddress: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address bin: type: string pattern: ^\d{9}$ status: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/physicalCardStatus design: type: string freezeReason: type: string required: - createdAt - last4Digits - expirationDate - status relationships: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/cardRelationships required: - attributes - relationships BusinessDebitCard: title: Business Debit Card type: object allOf: - $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags createdAt: type: string format: date-time updatedAt: type: string format: date-time last4Digits: type: string pattern: ^\d{4}$ expirationDate: type: string pattern: ^\d{4}[-](1[012]|0[1-9])$ shippingAddress: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email dateOfBirth: type: string format: date nationality: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality ssn: type: string pattern: ^\d{9}$ passport: type: string bin: type: string pattern: ^\d{9}$ status: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/physicalCardStatus design: type: string freezeReason: type: string required: - createdAt - last4Digits - expirationDate - address - fullName - phone - email - dateOfBirth relationships: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/cardRelationships required: - attributes - relationships IndividualVirtualDebitCard: title: Individual Virtual Debit Card type: object allOf: - $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags createdAt: type: string format: date-time updatedAt: type: string format: date-time last4Digits: type: string pattern: ^\d{4}$ expirationDate: type: string pattern: ^\d{4}[-](1[012]|0[1-9])$ bin: type: string pattern: ^\d{9}$ status: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/virtualCardStatus freezeReason: type: string required: - createdAt - last4Digits - expirationDate - status relationships: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/cardRelationships required: - attributes - relationships BusinessVirtualDebitCard: title: Business Virtual Debit Card type: object allOf: - $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags createdAt: type: string format: date-time updatedAt: type: string format: date-time last4Digits: type: string pattern: ^\d{4}$ expirationDate: type: string pattern: ^\d{4}[-](1[012]|0[1-9])$ address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email dateOfBirth: type: string format: date nationality: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality ssn: type: string pattern: ^\d{9}$ passport: type: string bin: type: string pattern: ^\d{9}$ status: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/virtualCardStatus freezeReason: type: string required: - createdAt - last4Digits - expirationDate - address - fullName - phone - email - dateOfBirth relationships: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/cardRelationships required: - attributes - relationships BusinessCreditCard: title: Business Credit Card type: object allOf: - $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags createdAt: type: string format: date-time updatedAt: type: string format: date-time last4Digits: type: string pattern: ^\d{4}$ expirationDate: type: string pattern: ^\d{4}[-](1[012]|0[1-9])$ shippingAddress: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email dateOfBirth: type: string format: date nationality: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality ssn: type: string pattern: ^\d{9}$ passport: type: string bin: type: string pattern: ^\d{9}$ status: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/physicalCardStatus design: type: string freezeReason: type: string required: - createdAt - last4Digits - expirationDate - address - fullName - phone - email - dateOfBirth relationships: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/cardRelationships required: - attributes - relationships BusinessVirtualCreditCard: title: Business Virtual Credit Card type: object allOf: - $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags createdAt: type: string format: date-time updatedAt: type: string format: date-time last4Digits: type: string pattern: ^\d{4}$ expirationDate: type: string pattern: ^\d{4}[-](1[012]|0[1-9])$ address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address fullName: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName phone: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone email: $ref: >- #/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createOfficer/properties/email dateOfBirth: type: string format: date nationality: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality ssn: type: string pattern: ^\d{9}$ passport: type: string bin: type: string pattern: ^\d{9}$ status: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/virtualCardStatus freezeReason: type: string required: - createdAt - last4Digits - expirationDate - address - fullName - phone - email - dateOfBirth relationships: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/cardRelationships required: - attributes - relationships type: object properties: type: type: string id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id discriminator: propertyName: type mapping: businessDebitCard: '#/definitions/BusinessDebitCard' individualDebitCard: '#/definitions/IndividualDebitCard' businessVirtualDebitCard: '#/definitions/BusinessVirtualDebitCard' individualVirtualDebitCard: '#/definitions/IndividualVirtualDebitCard' businessCreditCard: '#/definitions/BusinessCreditCard' businessVirtualCreditCard: '#/definitions/BusinessVirtualCreditCard' GetCardPinStatusPinStatusResponse: title: UnitCardResponse type: object properties: data: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/pinStatus ReportCardAsStolenViaApiResponse: title: UnitCardResponse type: object properties: data: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data ReportCardAsLostViaApiResponse: title: UnitCardResponse type: object properties: data: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data CloseACardViaApiResponse: title: UnitCardResponse type: object properties: data: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data FreezeACardViaApiResponse: title: UnitCardResponse type: object properties: data: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data UnfreezeACardByIdResponse: title: UnitCardResponse type: object properties: data: $ref: >- #/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data GetCardLimitsByIdResponse: title: UnitCardResponse type: object properties: data: title: Account Limits Resource definitions: DepositLimits: title: Deposit Account Limits type: object allOf: - $ref: >- #/paths/~1cards~1%7BcardId%7D~1limits/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data - type: object properties: attributes: type: object properties: ach: type: object properties: limits: type: object properties: dailyDebit: type: number dailyCredit: type: number monthlyDebit: type: number monthlyDebitSoft: type: number dailyDebitSoft: type: number monthlyCredit: type: number required: - dailyDebit - dailyCredit - monthlyDebit - monthlyCredit totalsDaily: type: object properties: debits: type: number credits: type: number required: - debits - credits totalsMonthly: type: object properties: debits: type: number credits: type: number required: - debits - credits required: - limits - totalsDaily - totalsMonthly card: type: object properties: limits: type: object properties: dailyWithdrawal: type: number dailyDeposit: type: number dailyPurchase: type: number dailyCardTransaction: type: number required: - dailyWithdrawal - dailyDeposit - dailyPurchase - dailyCardTransaction totalsDaily: type: object properties: withdrawals: type: number deposits: type: number purchases: type: number cardTransactions: type: number required: - withdrawals - deposits - purchases - cardTransactions required: - limits - totalsDaily checkDeposit: type: object properties: limits: type: object properties: daily: type: number monthly: type: number dailySoft: type: number monthlySoft: type: number required: - daily - monthly - dailySoft - monthlySoft totalsDaily: type: number totalsMonthly: type: number required: - limits - totalsDaily - totalsMonthly required: - ach - card - checkDeposit required: - attributes CreditLimits: title: Credit Account Limits type: object allOf: - $ref: >- #/paths/~1cards~1%7BcardId%7D~1limits/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data - type: object properties: attributes: type: object properties: card: type: object properties: limits: type: object properties: dailyWithdrawal: type: number dailyDeposit: type: number dailyPurchase: type: number dailyCardTransaction: type: number required: - dailyWithdrawal - dailyDeposit - dailyPurchase - dailyCardTransaction totalsDaily: type: object properties: withdrawals: type: number deposits: type: number purchases: type: number cardTransactions: type: number required: - withdrawals - deposits - purchases - cardTransactions required: - limits - totalsDaily required: - card required: - attributes type: object properties: type: type: string discriminator: propertyName: type mapping: limits: '#/definitions/DepositLimits' creditLimits: '#/definitions/CreditLimits' GetListAuthorizationsFromApiResponse: title: UnitListAuthorizationsResponse type: object properties: data: type: array items: $ref: >- #/paths/~1authorizations~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data GetAuthorizationByIdResponse: title: UnitAuthorizationResponse type: object properties: data: title: Authorization Document definitions: authorizationRelationships: title: authorizationRelationships type: object type: object properties: type: type: string default: authorization id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time amount: type: integer cardLast4Digits: type: string merchant: title: Merchant type: object properties: name: type: string type: type: integer category: type: string location: type: string id: type: string required: - name - type - category recurring: type: boolean status: type: string declineReason: type: string paymentMethod: type: string digitalWallet: type: string cardVerificationData: title: Card Verification Data type: object properties: verificationMethod: type: string required: - verificationMethod cardNetwork: type: string cashWithdrawalAmount: type: integer required: - createdAt - amount - cardLast4Digits - merchant - recurring - status relationships: $ref: >- #/paths/~1authorizations~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/authorizationRelationships required: - type - id - relationships GetListAuthorizationRequestsFromApiResponse: title: UnitListAuthorizationRequestsResponse type: object properties: data: type: array items: $ref: >- #/paths/~1authorization-requests~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data GetAuthorizationRequestByIdResponse: title: UnitAuthorizationRequestsResponse type: object properties: data: title: AuthorizationRequest Document definitions: approveAuthorizationRequest: title: Approve Authorization Request type: object properties: type: type: string default: approveAuthorizationRequest attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags amount: type: integer fundingAccount: type: string required: - type - attributes declineAuthorizationRequest: title: Decline Authorization Request type: object properties: type: type: string default: declineAuthorizationRequest attributes: type: object properties: reason: type: string enum: - AccountClosed - CardExceedsAmountLimit - DoNotHonor - InsufficientFunds - InvalidMerchant - ReferToCardIssuer - RestrictedCard - TransactionNotPermittedToCardholder required: - type - attributes authorizationRequestRelationships: title: authorizationRequestRelationships type: object properties: customer: type: object properties: data: type: object properties: type: type: string default: customer id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data account: type: object properties: data: type: object properties: type: type: string default: account id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data fundingAccount: type: object properties: data: type: object properties: type: type: string default: account id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data card: type: object properties: data: type: object properties: type: type: string default: card id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data required: - customer - account - card PurchaseAuthorizationRequest: title: PurchaseAuthorizationRequest Resource type: object allOf: - $ref: >- #/paths/~1authorization-requests~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags createdAt: type: string format: date-time amount: type: integer status: type: string partialApprovalAllowed: type: boolean approvedAmount: type: integer declineReason: type: string merchant: $ref: >- #/paths/~1authorizations~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/properties/attributes/properties/merchant recurring: type: boolean healthcareAmounts: title: Healthcare Amounts type: object properties: transitAmount: type: integer prescriptionRXAmount: type: integer visionOpticalAmount: type: integer clinicOtherQualifiedMedicalAmount: type: integer dentalAmount: type: integer totalHealthcareAmount: type: integer required: - transitAmount - prescriptionRXAmount - visionOpticalAmount - clinicOtherQualifiedMedicalAmount - dentalAmount - totalHealthcareAmount paymentMethod: type: string digitalWallet: type: string cardVerificationData: $ref: >- #/paths/~1authorizations~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/properties/attributes/properties/cardVerificationData ecommerce: type: boolean cardPresent: type: boolean cardNetwork: type: string cashWithdrawalAmount: type: integer required: - createdAt - amount - status - partialApprovalAllowed - merchant - recurring relationships: $ref: >- #/paths/~1authorization-requests~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/authorizationRequestRelationships required: - relationships CardTransactionAuthorizationRequest: title: CardTransactionAuthorizationRequest Resource type: object allOf: - $ref: >- #/paths/~1authorization-requests~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags createdAt: type: string format: date-time amount: type: integer status: type: string partialApprovalAllowed: type: boolean approvedAmount: type: integer declineReason: type: string merchant: $ref: >- #/paths/~1authorizations~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/properties/attributes/properties/merchant recurring: type: boolean paymentMethod: type: string digitalWallet: type: string cardVerificationData: $ref: >- #/paths/~1authorizations~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/properties/attributes/properties/cardVerificationData cardNetwork: type: string required: - createdAt - amount - status - partialApprovalAllowed - merchant - recurring relationships: $ref: >- #/paths/~1authorization-requests~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/authorizationRequestRelationships required: - relationships AtmAuthorizationRequest: title: AtmAuthorizationRequest Resource type: object allOf: - $ref: >- #/paths/~1authorization-requests~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags createdAt: type: string format: date-time amount: type: integer status: type: string partialApprovalAllowed: type: boolean approvedAmount: type: integer declineReason: type: string direction: type: string atmName: type: string atmLocation: type: string surcharge: type: integer internationalServiceFee: type: number nullable: true cardNetwork: type: string required: - createdAt - amount - status - partialApprovalAllowed - direction - atmName - surcharge relationships: $ref: >- #/paths/~1authorization-requests~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/authorizationRequestRelationships required: - relationships type: object properties: type: type: string id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id discriminator: propertyName: type mapping: purchaseAuthorizationRequest: '#/definitions/PurchaseAuthorizationRequest' cardTransactionAuthorizationRequest: '#/definitions/CardTransactionAuthorizationRequest' atmAuthorizationRequest: '#/definitions/AtmAuthorizationRequest' ApproveAuthorizationRequestByIdResponse: title: UnitAuthorizationRequestResponse type: object properties: data: $ref: >- #/paths/~1authorization-requests~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data DeclineAuthorizationRequestViaApiResponse: title: UnitAuthorizationRequestResponse type: object properties: data: $ref: >- #/paths/~1authorization-requests~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data GetListStatementsFromApiResponse: title: UnitStatementsResponse type: object properties: data: type: array items: title: Statement definitions: statementRelationships: type: object properties: account: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account customer: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account customers: $ref: >- #/paths/~1accounts/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateDepositAccount/properties/relationships/properties/customers type: object properties: type: type: string id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id attributes: type: object properties: period: type: string relationships: $ref: >- #/paths/~1statements/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items/definitions/statementRelationships required: - type - id - relationships - attributes GetStatementHtmlByIdResponse: type: string GetStatementPdfByIdResponse: type: string format: binary GetBankVerificationPdfFromApiResponse: type: string format: binary GetListRewardsFromApiResponse: title: UnitRewardsListResponse type: object properties: data: type: array items: $ref: >- #/paths/~1rewards/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data CreateRewardViaApiResponse: title: UnitRewardResponse type: object properties: data: title: Reward definitions: rewardRelationships: type: object properties: receivingAccount: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account fundingAccount: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account customer: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account rewardedTransaction: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account transaction: title: transactionRelationship type: object properties: data: type: object properties: type: type: string default: transaction id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data card: title: cardRelationship type: object properties: data: type: object properties: type: type: string default: card id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data required: - receivingAccount - fundingAccount - customer type: object properties: type: type: string default: reward id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags description: type: string maxLength: 50 createdAt: type: string format: date-time amount: type: integer minimum: 1 status: type: string enum: - Rejected - Sent rejectReason: type: string required: - description - createdAt - amount - tags - status relationships: $ref: >- #/paths/~1rewards/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/rewardRelationships required: - type - id - relationships - attributes GetRewardByIdResponse: title: UnitRewardResponse type: object properties: data: $ref: >- #/paths/~1rewards/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data GetListEventsFromApiResponse: title: UnitEventListResponse type: object properties: data: type: array items: $ref: >- #/paths/~1events~1%7BeventId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data GetEventByIdResponse: title: UnitEventResponse type: object properties: data: title: Event Resource type: object properties: type: type: string id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id attributes: type: object properties: {} relationships: title: eventRelationships type: object properties: {} required: - type - id FireEventByIdResponse: title: UnitEventResponse type: object properties: data: $ref: >- #/paths/~1events~1%7BeventId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data GetInstitutionByRoutingNumberResponse: title: UnitInstitutionResponse type: object properties: data: title: Institution Resource type: object properties: type: type: string default: institution attributes: type: object properties: routingNumber: type: string name: type: string address: type: string isWireSupported: type: boolean isACHSupported: type: boolean required: - routingNumber - name - isWireSupported - isACHSupported required: - type - attributes CreateFeeViaApiResponse: title: UnitFeeResponse type: object properties: data: title: Fee definitions: feeRelationships: title: feeRelationships type: object properties: account: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account required: - account type: object properties: type: type: string default: fee id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags description: type: string maxLength: 50 amount: type: integer minimum: 1 required: - amount - description relationships: $ref: >- #/paths/~1fees/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/feeRelationships GetListCheckDepositsFromApiResponse: title: UnitListCheckDepositsResponse type: object properties: data: type: array items: $ref: >- #/paths/~1check-deposits/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data CreateCheckDepositViaApiResponse: title: UnitCheckDepositResponse type: object properties: data: title: Check Deposit definitions: checkDepositStatus: type: string enum: - AwaitingImages - AwaitingFrontImage - AwaitingBackImage - AwaitingCustomerConfirmation - Pending - PendingReview - Rejected - Clearing - Sent - Canceled - Returned checkDepositRelationships: title: checkDepositRelationships type: object properties: org: $ref: >- #/paths/~1customers~1%7BcustomerId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/relationships/properties/org account: type: object properties: data: type: object properties: type: type: string enum: - account - depositAccount - batchAccount id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data additionalProperties: true customer: type: object properties: data: type: object properties: type: type: string enum: - businessCustomer - individualCustomer - customer id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data transaction: type: object properties: data: type: object properties: type: type: string default: transaction id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data required: - account statusEvent: type: object properties: updatedAt: type: string updatedBy: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id status: type: object properties: type: $ref: >- #/paths/~1check-deposits/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/checkDepositStatus required: - status counterparty: title: Counterparty type: object properties: routingNumber: type: string pattern: ^\d{9}$ accountNumber: type: string maxLength: 17 name: type: string minLength: 1 maxLength: 250 required: - routingNumber - accountNumber - name type: object properties: type: type: string enum: - checkDeposit id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags description: type: string minLength: 1 maxLength: 50 createdAt: type: string format: date-time settlementDate: type: string format: date amount: type: integer minimum: 1 status: type: string enum: - AwaitingImages - AwaitingFrontImage - AwaitingBackImage - Pending - PendingReview - AwaitingCustomerConfirmation - Rejected - Clearing - Sent - Canceled - Returned reason: type: string nullable: true statusCreatedAt: type: string format: date-time statusSetBy: type: string statusHistory: type: array items: $ref: >- #/paths/~1check-deposits/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/statusEvent reasonText: type: string checkNumber: type: string vendor: type: string counterparty: $ref: >- #/paths/~1check-deposits/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/counterparty required: - createdAt - amount - description - status relationships: $ref: >- #/paths/~1check-deposits/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/checkDepositRelationships required: - type - id - attributes - relationships GetCheckDepositByIdResponse: title: UnitCheckDepositResponse type: object properties: data: $ref: >- #/paths/~1check-deposits/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data UpdateCheckDepositByIdResponse: title: UnitCheckDepositResponse type: object properties: data: $ref: >- #/paths/~1check-deposits/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data ConfirmCheckDepositByIdResponse: title: UnitCheckDepositResponse type: object properties: data: $ref: >- #/paths/~1check-deposits/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data GetCheckDepositFrontImageByIdResponse: title: UnitCheckDepositResponse type: object properties: data: type: string GetCheckDepositBackImageByIdResponse: title: UnitCheckDepositResponse type: object properties: data: type: string GetListOrgApiTokensFromApiResponse: title: UnitOrgApiTokensListResponse type: object properties: data: type: array items: $ref: >- #/paths/~1users~1%7BuserId%7D~1api-tokens/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data CreateOrgApiTokenViaApiResponse: title: UnitApiTokenResponse type: object properties: data: title: apiToken type: object properties: type: type: string default: apiToken id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id attributes: type: object properties: description: type: string createdAt: type: string format: date-time expiration: type: string format: date-time token: type: string sourceIp: type: string required: - createdAt RevokeOrgApiTokenRewardByIdResponse: title: UnitApiTokenResponse type: object properties: data: $ref: >- #/paths/~1users~1%7BuserId%7D~1api-tokens/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data CreateCustomerTokenViaApiResponse: title: UnitCustomerTokenResponse type: object properties: data: title: CustomerToken type: object properties: type: type: string default: customerToken attributes: type: object properties: token: type: string expiresIn: type: integer required: - type - attributes CreateCustomerTokenVerificationViaApiResponse: title: UnitCustomerTokenVerificationResponse type: object properties: data: title: CustomerTokenVerification type: object properties: type: type: string default: customerTokenVerification attributes: type: object properties: verificationToken: type: string required: - type - id - attributes GetListWebhooksFromApiResponse: title: UnitWebhooksListResponse type: object properties: data: type: array items: $ref: >- #/paths/~1webhooks/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data CreateWebhookViaApiResponse: title: UnitWebhookResponse type: object properties: data: title: Webhook type: object properties: type: type: string default: webhook id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id attributes: type: object properties: createdAt: type: string format: date-time label: type: string url: type: string status: type: string contentType: type: string enum: - Json - JsonAPI deliveryMode: type: string enum: - AtMostOnce - AtLeastOnce token: type: string subscriptionType: type: string required: - type - id - attributes GetWebhookByIdResponse: title: UnitWebhookResponse type: object properties: data: $ref: >- #/paths/~1webhooks/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data UpdateWebhookViaApiResponse: title: UnitWebhookResponse type: object properties: data: $ref: >- #/paths/~1webhooks/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data EnableWebhookViaApiResponse: title: UnitWebhookResponse type: object properties: data: $ref: >- #/paths/~1webhooks/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data DisableWebhookViaApiResponse: title: UnitWebhookResponse type: object properties: data: $ref: >- #/paths/~1webhooks/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data GetAtmLocationsListFromApiResponse: title: UnitAtmLocationsListResponse type: array items: title: AtmLocation type: object properties: type: type: string default: atmLocation attributes: type: object properties: network: type: string locationName: type: string coordinates: type: object properties: longitude: type: number latitude: type: number required: - longitude - latitude address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address distance: type: integer surchargeFree: type: boolean acceptDeposits: type: boolean required: - type - attributes GetTransactionByIdResponse: title: UnitTransactionResponse type: object properties: data: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data included: $ref: >- #/paths/~1transactions/get/responses/200/content/application~1vnd.api%2Bjson/schema/properties/included UpdateTransactionViaApiResponse: title: UnitTransactionResponse type: object properties: data: title: Transaction Resource definitions: transactionRelationships: title: transactionRelationships type: object properties: account: title: accountRelationship type: object properties: data: type: object properties: type: type: string enum: - depositAccount - glAccount - account id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data receivingAccount: title: receivingAccountRelationship type: object properties: data: type: object properties: type: type: string enum: - depositAccount - account id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data customer: title: customerRelationship type: object properties: data: type: object properties: type: type: string enum: - businessCustomer - individualCustomer - customer id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data customers: $ref: >- #/paths/~1accounts/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateDepositAccount/properties/relationships/properties/customers counterpartyAccount: title: counterpartyAccountRelationship type: object properties: data: type: object properties: type: type: string default: account id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data counterpartyCustomer: title: counterpartyCustomerRelationship type: object properties: data: type: object properties: type: type: string default: customer id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data relatedTransaction: title: relatedTransactionRelationship type: object properties: data: type: object properties: type: type: string default: transaction id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data disputedTransaction: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships/properties/relatedTransaction authorization: title: authorizationRelationship type: object properties: data: type: object properties: type: type: string default: authorization id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data returned: title: returnedRelationship type: object properties: data: type: object properties: type: type: string default: transaction id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data payment: title: paymentRelationship type: object properties: data: type: object properties: type: type: string default: payment id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data checkPayment: title: checkPaymentRelationship type: object properties: data: type: object properties: type: type: string default: payment id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data repayment: title: repaymentRelationship type: object properties: data: type: object properties: type: type: string default: repayment id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data recurringPayment: title: recurringPaymentRelationship type: object properties: data: type: object properties: type: type: string default: recurringPayment id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data org: $ref: >- #/paths/~1customers~1%7BcustomerId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/relationships/properties/org card: title: cardRelationship type: object properties: data: type: object properties: type: type: string default: card id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data incomingAch: title: incomingAchRelationship type: object properties: data: type: object properties: type: type: string default: incomingAch id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data checkDeposit: title: checkDepositRelationship type: object properties: data: type: object properties: type: type: string default: checkDeposit id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data authorizationRequest: title: authorizationRequestRelationship type: object properties: data: type: object properties: type: type: string default: authorizationRequest id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data paymentAdvanceTransaction: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships/properties/relatedTransaction receivedPayment: title: receivedPaymentRelationship type: object properties: data: type: object properties: type: type: string default: receivedPayment id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data chargeback: title: chargebackRelationship type: object properties: data: type: object properties: type: type: string default: chargeback id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data reward: title: rewardRelationship type: object properties: data: type: object properties: type: type: string default: reward id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - type - id required: - account OriginatedAchTransaction: title: Originated ACH type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string description: type: string createdAt: type: string format: date-time direction: type: string enum: - Credit - Debit amount: type: integer balance: type: integer addenda: type: string counterparty: $ref: >- #/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/counterparty secCode: type: string traceNumber: type: string required: - createdAt - amount - direction - balance - summary - description - counterparty relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships ReceivedAchTransaction: title: Received ACH type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string description: type: string createdAt: type: string format: date-time direction: type: string enum: - Credit - Debit amount: type: integer balance: type: integer addenda: type: string companyName: type: string counterpartyName: type: string counterpartyRoutingNumber: type: string traceNumber: type: string secCode: type: string minLength: 3 maxLength: 3 required: - createdAt - amount - direction - balance - summary - description - companyName - counterpartyRoutingNumber relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships ReturnedAchTransaction: title: Returned ACH type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time direction: type: string enum: - Credit - Debit amount: type: integer balance: type: integer companyName: type: string counterpartyName: type: string counterpartyRoutingNumber: type: string reason: type: string achReason: type: string required: - createdAt - amount - direction - balance - summary - companyName - counterpartyName - counterpartyRoutingNumber - reason relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships ReturnedReceivedAchTransaction: title: Returned Received ACH type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time direction: type: string enum: - Credit - Debit amount: type: integer balance: type: integer companyName: type: string reason: type: string required: - createdAt - amount - direction - balance - summary - companyName - reason relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships DishonoredAchTransaction: title: Dishonored Return ACH type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string description: type: string createdAt: type: string format: date-time direction: type: string enum: - Credit - Debit amount: type: integer balance: type: integer companyName: type: string counterpartyName: type: string counterpartyRoutingNumber: type: string traceNumber: type: string reason: type: string secCode: type: string minLength: 3 maxLength: 3 required: - createdAt - amount - direction - balance - summary - description - companyName - counterpartyRoutingNumber relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships BookTransaction: title: Book type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time direction: type: string enum: - Credit - Debit amount: type: integer balance: type: integer counterparty: $ref: >- #/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/counterparty required: - createdAt - amount - direction - balance - summary - counterparty relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships PurchaseTransaction: title: Purchase type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time direction: type: string enum: - Credit - Debit amount: type: integer balance: type: integer cardLast4Digits: type: string merchant: $ref: >- #/paths/~1authorizations~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/properties/attributes/properties/merchant coordinates: $ref: >- #/paths/~1atm-locations/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/attributes/properties/coordinates recurring: type: boolean networkTransactionId: type: string interchange: type: string nullable: true ecommerce: type: boolean cardPresent: type: boolean internationalServiceFee: type: integer nullable: true paymentMethod: type: string digitalWallet: type: string cardVerificationData: $ref: >- #/paths/~1authorizations~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/properties/attributes/properties/cardVerificationData cardNetwork: type: string required: - createdAt - amount - direction - balance - summary - cardLast4Digits - merchant - recurring - ecommerce - cardPresent relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships AtmTransaction: title: ATM type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time direction: type: string enum: - Credit - Debit amount: type: integer balance: type: integer cardLast4Digits: type: string atmName: type: string atmLocation: type: string surcharge: type: integer networkTransactionId: type: string interchange: type: string nullable: true internationalServiceFee: type: integer nullable: true cardNetwork: type: string required: - createdAt - amount - direction - balance - summary - cardLast4Digits - atmName - surcharge relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships FeeTransaction: title: Fee type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time direction: type: string enum: - Credit - Debit amount: type: integer balance: type: integer required: - createdAt - amount - direction - balance - summary relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships ReversalTransaction: title: Reversal type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time direction: type: string enum: - Credit - Debit amount: type: integer balance: type: integer cardLast4Digits: type: string networkTransactionId: type: string internationalServiceFee: type: integer nullable: true required: - createdAt - amount - direction - balance - summary - cardLast4Digits relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships CardTransaction: title: cardTransaction type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time direction: type: string enum: - Credit - Debit amount: type: integer balance: type: integer cardLast4Digits: type: string networkTransactionId: type: string interchange: type: string nullable: true internationalServiceFee: type: integer nullable: true merchant: $ref: >- #/paths/~1authorizations~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/properties/attributes/properties/merchant recurring: type: boolean paymentMethod: type: string digitalWallet: type: string cardVerificationData: $ref: >- #/paths/~1authorizations~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/properties/attributes/properties/cardVerificationData cardNetwork: type: string required: - createdAt - amount - direction - balance - summary - cardLast4Digits - merchant - recurring relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships WireTransaction: title: wireTransaction type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string description: type: string createdAt: type: string format: date-time direction: type: string enum: - Credit - Debit amount: type: integer balance: type: integer counterparty: $ref: >- #/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/counterparty senderReference: type: string referenceForBeneficiary: type: string originatorToBeneficiaryInformation: type: string beneficiaryInformation: type: string beneficiaryAdviceInformation: type: string imadOmad: type: object properties: imad: type: string omad: type: string required: - createdAt - amount - direction - balance - summary - counterparty relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships AdjustmentTransaction: title: adjustmentTransaction type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string description: type: string createdAt: type: string format: date-time direction: type: string enum: - Credit - Debit amount: type: integer balance: type: integer required: - createdAt - amount - direction - balance - summary relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships InterchangeTransaction: title: interchangeShareTransaction type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time direction: type: string enum: - Credit - Debit amount: type: integer balance: type: integer required: - createdAt - amount - direction - balance - summary relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships InterestShareTransaction: title: interestShareTransaction type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time direction: type: string enum: - Credit - Debit amount: type: integer balance: type: integer required: - createdAt - amount - direction - balance - summary relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships InterestTransaction: title: interestTransaction type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time direction: type: string enum: - Credit - Debit amount: type: integer balance: type: integer required: - createdAt - amount - direction - balance - summary relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships BankRepaymentTransaction: title: bankRepaymentTransaction type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time direction: type: string enum: - Credit - Debit amount: type: integer balance: type: integer paidForDate: type: string required: - createdAt - amount - direction - balance - summary - paidForDate relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships CustomerRepaymentReturnedTransaction: title: customerRepaymentReturnedTransaction type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time direction: type: string enum: - Credit - Debit amount: type: integer balance: type: integer required: - createdAt - amount - direction - balance - summary relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships CustomerRepaymentTransaction: title: customerRepaymentTransaction type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time direction: type: string enum: - Credit - Debit amount: type: integer balance: type: integer required: - createdAt - amount - direction - balance - summary relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships ReleaseTransaction: title: releaseTransaction type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string description: type: string createdAt: type: string format: date-time direction: type: string enum: - Credit - Debit amount: type: integer balance: type: integer senderName: type: string senderAccountNumber: type: string maxLength: 17 senderAddress: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address counterparty: $ref: >- #/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/counterparty required: - createdAt - amount - direction - balance - summary - counterparty relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships DisputeSettlementTransaction: title: disputeSettlementTransaction type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time direction: type: string enum: - Credit - Debit amount: type: integer balance: type: integer required: - createdAt - amount - direction - balance - summary relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships DisputeTransaction: title: disputeTransaction type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time direction: type: string enum: - Credit - Debit amount: type: integer balance: type: integer reason: type: string disputeId: type: string required: - createdAt - amount - direction - balance - summary - reason - disputeId relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships CheckDepositTransaction: title: checkDepositTransaction type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time amount: type: integer direction: type: string enum: - Credit - Debit balance: type: integer required: - createdAt - amount - direction - balance - summary relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships ReturnedCheckDepositTransaction: title: returnedCheckDepositTransaction type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time amount: type: integer direction: type: string enum: - Credit - Debit balance: type: integer reason: type: string required: - createdAt - amount - direction - balance - summary relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships PaymentCanceledTransaction: title: paymentCanceledTransaction type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time amount: type: integer direction: type: string enum: - Credit - Debit balance: type: integer reason: type: string required: - createdAt - amount - direction - balance - summary relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships BillPayTransaction: title: billPayTransaction type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time amount: type: integer direction: type: string enum: - Credit - Debit balance: type: integer required: - createdAt - amount - direction - balance - summary relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships SettlementTransaction: title: settlementTransaction type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time amount: type: integer direction: type: string enum: - Credit - Debit balance: type: integer required: - createdAt - amount - direction - balance - summary relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships SponsoredInterestTransaction: title: sponsoredInterestTransaction type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time amount: type: integer direction: type: string enum: - Credit - Debit balance: type: integer required: - createdAt - amount - direction - balance - summary relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships PaymentAdvanceTransaction: title: paymentAdvanceTransaction type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time amount: type: integer direction: type: string enum: - Credit - Debit balance: type: integer required: - createdAt - amount - direction - balance - summary relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships RepaidPaymentAdvanceTransaction: title: repaidPaymentAdvanceTransaction type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time amount: type: integer direction: type: string enum: - Credit - Debit balance: type: integer required: - createdAt - amount - direction - balance - summary relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships ChargebackTransaction: title: Chargeback type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time direction: type: string enum: - Credit - Debit counterparty: $ref: >- #/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/counterparty amount: type: integer balance: type: integer required: - createdAt - amount - direction - balance - summary relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships CheckPaymentTransaction: title: checkPaymentTransaction type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time amount: type: integer direction: type: string enum: - Credit - Debit balance: type: integer required: - createdAt - amount - direction - balance - summary relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships ReturnedCheckPaymentTransaction: title: returnedCheckPaymentTransaction type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time amount: type: integer direction: type: string enum: - Credit - Debit balance: type: integer reason: type: string required: - createdAt - amount - direction - balance - summary - reason relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships RewardTransaction: title: Reward type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time direction: type: string enum: - Credit - Debit receiverCounterparty: $ref: >- #/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/counterparty amount: type: integer balance: type: integer required: - createdAt - amount - direction - balance - summary - receiverCounterparty relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships NegativeBalanceCoverageTransaction: title: NegativeBalanceCoverage type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time direction: type: string enum: - Credit - Debit amount: type: integer balance: type: integer required: - createdAt - amount - direction - balance - summary relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships AccountLowBalanceClosureTransaction: title: AccountLowBalanceClosure type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time direction: type: string enum: - Credit - Debit amount: type: integer balance: type: integer required: - createdAt - amount - balance - summary relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships CashDepositTransaction: title: cashDepositTransaction type: object allOf: - $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags summary: type: string createdAt: type: string format: date-time direction: type: string enum: - Credit - Debit amount: type: integer balance: type: integer recurring: type: boolean required: - createdAt - amount - direction - balance - summary - cardLast4Digits - merchant - recurring relationships: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships required: - attributes - relationships type: object properties: id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id type: type: string discriminator: propertyName: type mapping: originatedAchTransaction: '#/definitions/OriginatedAchTransaction' receivedAchTransaction: '#/definitions/ReceivedAchTransaction' returnedAchTransaction: '#/definitions/ReturnedAchTransaction' returnedReceivedAchTransaction: '#/definitions/ReturnedReceivedAchTransaction' dishonoredAchTransaction: '#/definitions/DishonoredAchTransaction' purchaseTransaction: '#/definitions/PurchaseTransaction' bookTransaction: '#/definitions/BookTransaction' atmTransaction: '#/definitions/AtmTransaction' feeTransaction: '#/definitions/FeeTransaction' reversalTransaction: '#/definitions/ReversalTransaction' cardTransaction: '#/definitions/CardTransaction' releaseTransaction: '#/definitions/ReleaseTransaction' wireTransaction: '#/definitions/WireTransaction' interchangeTransaction: '#/definitions/InterchangeTransaction' interestShareTransaction: '#/definitions/InterestShareTransaction' interestTransaction: '#/definitions/InterestTransaction' adjustmentTransaction: '#/definitions/AdjustmentTransaction' disputeSettlementTransaction: '#/definitions/DisputeSettlementTransaction' disputeTransaction: '#/definitions/DisputeTransaction' checkDepositTransaction: '#/definitions/CheckDepositTransaction' returnedCheckDepositTransaction: '#/definitions/ReturnedCheckDepositTransaction' billPayTransaction: '#/definitions/BillPayTransaction' settlementTransaction: '#/definitions/SettlementTransaction' sponsoredInterestTransaction: '#/definitions/SponsoredInterestTransaction' paymentAdvanceTransaction: '#/definitions/PaymentAdvanceTransaction' repaidPaymentAdvanceTransaction: '#/definitions/RepaidPaymentAdvanceTransaction' chargebackTransaction: '#/definitions/ChargebackTransaction' rewardTransaction: '#/definitions/RewardTransaction' negativeBalanceCoverageTransaction: '#/definitions/NegativeBalanceCoverageTransaction' accountLowBalanceClosureTransaction: '#/definitions/AccountLowBalanceClosureTransaction' bankRepaymentTransaction: '#/definitions/BankRepaymentTransaction' cashDepositTransaction: '#/definitions/CashDepositTransaction' customerRepaymentTransaction: '#/definitions/CustomerRepaymentTransaction' customerRepaymentReturnedTransaction: '#/definitions/CustomerRepaymentReturnedTransaction' checkPaymentTransaction: '#/definitions/CheckPaymentTransaction' returnedCheckPaymentTransaction: '#/definitions/ReturnedCheckPaymentTransaction' GetListTransactionsFromApiResponse: title: UnitTransactionsListResponse type: object properties: data: type: array items: $ref: >- #/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data included: type: array items: type: object properties: id: type: string type: type: string attributes: type: object relationships: type: object meta: $ref: >- #/paths/~1applications/get/responses/200/content/application~1vnd.api%2Bjson/schema/properties/meta GetListDisputesFromApiResponse: title: UnitDisputesListResponse type: array items: title: Dispute Document definitions: disputeRelationships: title: disputeRelationships type: object properties: customer: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account account: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account transaction: $ref: >- #/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account required: - customer - account - transaction type: object properties: type: type: string default: dispute id: type: string pattern: ^[1-9]\d*$ attributes: type: object properties: description: type: string maxLength: 1024 source: type: string enum: - DebitCard - ACH externalId: type: string maxLength: 255 link: type: string pattern: >- (http(s)?:\/\/.)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&//=]*) amount: type: integer status: type: string statusHistory: type: array items: type: object properties: type: type: string updatedAt: type: string format: date-time createdAt: type: string format: date-time decisionReason: type: string required: - externalId - source - description - status - createdAt - amount relationships: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/definitions/disputeRelationships required: - type - id - relationships GetDisputeByIdResponse: title: UnitDisputeResponse type: object properties: data: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items GetListRepaymentsFromApiResponse: title: UnitRepaymentsListResponse type: object properties: data: type: array items: title: Repayment Resource definitions: AchRepayment: title: ACH Repayment type: object allOf: - $ref: >- #/paths/~1repayments/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags createdAt: type: string format: date-time updatedAt: type: string format: date-time amount: type: integer minimum: 1 sameDay: type: boolean status: type: string enum: - Pending - PendingReview - Sent - Returned - Rejected - Clearing required: - createdAt - status - amount relationships: type: object properties: account: type: object properties: data: type: object properties: type: type: string enum: - depositAccount - account id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data creditAccount: type: object properties: data: type: object properties: type: type: string default: creditAccount id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data counterparty: type: object properties: data: type: object properties: type: type: string default: counterparty id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data customer: type: object properties: data: type: object properties: type: type: string enum: - businessCustomer - individualCustomer - customer id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data payment: type: object properties: data: type: object properties: type: type: string default: payment id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data BookRepayment: title: Book Repayment type: object allOf: - $ref: >- #/paths/~1repayments/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items - type: object properties: attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags createdAt: type: string format: date-time updatedAt: type: string format: date-time amount: type: integer minimum: 1 status: type: string enum: - Pending - PendingReview - Sent - Returned - Rejected required: - createdAt - status - amount relationships: type: object properties: account: type: object properties: data: type: object properties: type: type: string enum: - depositAccount - account id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data creditAccount: type: object properties: data: type: object properties: type: type: string default: creditAccount id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data counterpartyAccount: type: object properties: data: type: object properties: type: type: string default: account id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data customer: type: object properties: data: type: object properties: type: type: string enum: - businessCustomer - individualCustomer - customer id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data payment: type: object properties: data: type: object properties: type: type: string default: payment id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data type: object properties: id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id type: type: string discriminator: propertyName: type mapping: achRepayment: '#/definitions/AchRepayment' bookRepayment: '#/definitions/BookRepayment' meta: $ref: >- #/paths/~1applications/get/responses/200/content/application~1vnd.api%2Bjson/schema/properties/meta CreateARepaymentViaApiResponse: title: UnitRepaymentResponse type: object properties: data: $ref: >- #/paths/~1repayments/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items GetListCheckPaymentsFromApiResponse: title: UnitListCheckPaymentsResponse type: object properties: data: type: array items: title: Check Payment Resource type: object properties: type: type: string default: checkPayment id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags description: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time amount: type: integer minimum: 1 returnCutoffTime: type: string format: date-time status: type: string enum: - MarkedForReturn - Returned - Processed - PendingReview memo: type: string deliveryStatus: type: string enum: - Mailed - InLocalArea - Delivered - Rerouted - ReturnedToSender sendAt: type: string format: date-time counterparty: type: object properties: name: type: string address: $ref: >- #/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address counterpartyMoved: type: boolean trackedAt: type: string format: date-time postalCode: type: string expectedDelivery: type: string format: date originated: type: boolean expirationDate: type: string format: date rejectReason: type: string returnReason: $ref: >- #/paths/~1check-payments~1%7BcheckPaymentId%7D~1return/post/requestBody/content/application~1vnd.api%2Bjson/schema/properties/data/properties/attributes/properties/reason pendingReviewReasons: type: array items: type: string enum: - NameMissMatch - SoftLimit checkNumber: type: string onUsAuxiliary: type: string onUs: type: string counterpartyRoutingNumber: type: string additionalVerificationStatus: type: string enum: - Required - NotRequired - Approved required: - createdAt - updatedAt - amount - status - originated relationships: type: object properties: account: type: object properties: data: type: object properties: type: type: string enum: - depositAccount - account id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data customer: type: object properties: data: type: object properties: type: type: string enum: - businessCustomer - individualCustomer - customer id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data customers: $ref: >- #/paths/~1accounts/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateDepositAccount/properties/relationships/properties/customers transaction: type: object properties: data: type: object properties: type: type: string default: transaction id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data required: - account required: - type - id - attributes - relationships CreateCheckPaymentViaApiResponse: title: UnitCheckPaymentResponse type: object properties: data: $ref: >- #/paths/~1check-payments/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items GetAFrontImageViaApiResponse: type: string format: binary GetABackImageByApiResponse: type: string format: binary StopPaymentGetListResponse: type: object properties: data: type: array items: $ref: >- #/paths/~1stop-payments/post/responses/200/content/application~1json/schema/properties/data StopPaymentCreateResponse: type: object properties: data: title: Stop Payment type: object properties: type: type: string default: stopPayment id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id attributes: type: object properties: tags: $ref: >- #/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags createdAt: type: string format: date-time updatedAt: type: string format: date-time amount: type: integer minimum: 1 status: type: string enum: - Active - Disabled checkNumber: type: string required: - createdAt - updatedAt - amount - checkNumber relationships: type: object properties: account: type: object properties: data: type: object properties: type: type: string enum: - depositAccount - account id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data customer: type: object properties: data: type: object properties: type: type: string enum: - businessCustomer - individualCustomer - customer id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id required: - type - id required: - data customers: $ref: >- #/paths/~1accounts/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateDepositAccount/properties/relationships/properties/customers checkPayments: type: object properties: data: type: array items: type: object properties: id: $ref: >- #/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id type: type: string default: checkPayment required: - data required: - account - customer required: - type - id - attributes - relationships security: - bearerAuth: []