Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://api.s.unit.sh
/counterparties/{counterpartyId}
Delete Counterparty via API
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| counterpartyId | path | required | string | ID of the counterparty to delete |
DELETE /counterparties/{counterpartyId}
/users/{userId}/api-tokens/{tokenId}
Get a Reward from API
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| userId | path | required | string | ID of the user to revoke token |
| tokenId | path | required | string | ID of the token to revoke |
DELETE /users/{userId}/api-tokens/{tokenId}
/stop-payments/{stop_payment_id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| stop_payment_id | path | required | string | ID of the stop payment |
DELETE /stop-payments/{stop_payment_id}
ApproveAuthorizationRequestByIdRequest
{
"type": "object",
"title": "ApproveAuthorizationRequest",
"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"
}
}
}
ApproveAuthorizationRequestByIdResponse
{
"type": "object",
"title": "UnitAuthorizationRequestResponse",
"properties": {
"data": {
"$ref": "#/paths/~1authorization-requests~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data"
}
}
}
ApproveCheckPaymentByIdRequest
{
"type": "object",
"title": "ApproveCheckPaymentRequest",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"default": "additionalVerification"
}
}
}
}
}
ArchiveCustomerByIdRequest
{
"type": "object",
"title": "ArchiveCustomerRequest",
"properties": {
"type": {
"enum": [
"archiveCustomer"
],
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"reason": {
"enum": [
"Inactive",
"FraudACHActivity",
"FraudCardActivity",
"FraudCheckActivity",
"FraudApplicationHistory",
"FraudAccountActivity",
"FraudClientIdentified",
"FraudLinkedToFraudulentCustomer"
],
"type": "string"
}
}
}
}
}
CancelApplicationByIdRequest
{
"type": "object",
"title": "CancelApplicationRequest",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"enum": [
"cancelApplication"
],
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"reason": {
"type": "string"
}
}
}
}
}
}
}
CancelApplicationByIdResponse
{
"type": "object",
"title": "UnitCancelApplicationResponse",
"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"
}
}
}
}
CloseACardViaApiResponse
{
"type": "object",
"title": "UnitCardResponse",
"properties": {
"data": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
CloseAnAccountByIdRequest
{
"type": "object",
"title": "CloseAccountRequest",
"properties": {
"data": {
"type": "object",
"title": "CloseAccountRequest",
"properties": {
"type": {
"enum": [
"creditAccountClose",
"depositAccountClose"
],
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"reason": {
"enum": [
"ByCustomer",
"Fraud"
],
"type": "string",
"default": "ByCustomer"
},
"fraudReason": {
"enum": [
"ACHActivity",
"CardActivity",
"CheckActivity",
"ApplicationHistory",
"AccountActivity",
"ClientIdentified",
"IdentityTheft",
"LinkedToFraudulentCustomer"
],
"type": "string",
"nullable": true
}
}
}
}
}
}
}
ConfirmCheckDepositByIdResponse
{
"type": "object",
"title": "UnitCheckDepositResponse",
"properties": {
"data": {
"$ref": "#/paths/~1check-deposits/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
CreateACardViaApiRequest
{
"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"
}
]
}
},
"definitions": {
"BIN": {
"type": "object",
"required": [
"bin",
"institutionId"
],
"properties": {
"bin": {
"type": "string",
"pattern": "^\\d{9}$"
},
"institutionId": {
"type": "string",
"pattern": "^\\d{9}$"
}
}
},
"CreateBusinessDebitCard": {
"type": "object",
"title": "Create Business Debit Card",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"enum": [
"businessDebitCard"
],
"type": "string",
"default": "businessDebitCard"
},
"attributes": {
"type": "object",
"required": [
"address",
"fullName",
"phone",
"email",
"dateOfBirth"
],
"properties": {
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"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"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"design": {
"type": "string"
},
"limits": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessDebitCard/properties/attributes/properties/limits"
},
"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"
},
"passport": {
"type": "string"
},
"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])$"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"shippingAddress": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"activeForOnlineUse": {
"type": "boolean"
},
"printOnlyBusinessName": {
"type": "boolean"
},
"additionalEmbossedText": {
"type": "string",
"maxLength": 26
}
}
},
"relationships": {
"$ref": "#/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCardRelationships"
}
}
},
"createCardRelationships": {
"type": "object",
"title": "createCardRelationships",
"required": [
"account"
],
"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"
}
}
},
"CreateBusinessCreditCard": {
"type": "object",
"title": "Create Business Credit Card",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"enum": [
"businessCreditCard"
],
"type": "string",
"default": "businessCreditCard"
},
"attributes": {
"type": "object",
"required": [
"address",
"fullName",
"phone",
"email",
"dateOfBirth"
],
"properties": {
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"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"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"design": {
"type": "string"
},
"limits": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessDebitCard/properties/attributes/properties/limits"
},
"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"
},
"passport": {
"type": "string"
},
"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])$"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"shippingAddress": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"activeForOnlineUse": {
"type": "boolean"
},
"printOnlyBusinessName": {
"type": "boolean"
},
"additionalEmbossedText": {
"type": "string",
"maxLength": 26
}
}
},
"relationships": {
"$ref": "#/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCardRelationships"
}
}
},
"CreateIndividualDebitCard": {
"type": "object",
"title": "Create Individual Debit Card",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"enum": [
"individualDebitCard"
],
"type": "string",
"default": "individualDebitCard"
},
"attributes": {
"type": "object",
"properties": {
"bin": {
"$ref": "#/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/BIN"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"design": {
"type": "string"
},
"limits": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessDebitCard/properties/attributes/properties/limits"
},
"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])$"
},
"cardDesignId": {
"type": "string",
"maxLength": 16
},
"cardQualifier": {
"type": "string",
"pattern": "^(\\d{3})|([ ]{3})$"
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"shippingAddress": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"activeForOnlineUse": {
"type": "boolean"
},
"printOnlyBusinessName": {
"type": "boolean"
},
"additionalEmbossedText": {
"type": "string",
"maxLength": 26
}
}
},
"relationships": {
"$ref": "#/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCardRelationships"
}
}
},
"CreateBusinessVirtualDebitCard": {
"type": "object",
"title": "Create Business Virtual Debit Card",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"enum": [
"businessVirtualDebitCard"
],
"type": "string",
"default": "businessVirtualDebitCard"
},
"attributes": {
"type": "object",
"required": [
"address",
"fullName",
"phone",
"email",
"dateOfBirth"
],
"properties": {
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"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"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"limits": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessDebitCard/properties/attributes/properties/limits"
},
"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"
},
"passport": {
"type": "string"
},
"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])$"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
}
}
},
"relationships": {
"$ref": "#/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCardRelationships"
}
}
},
"CreateBusinessVirtualCreditCard": {
"type": "object",
"title": "Create Business Virtual Credit Card",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"enum": [
"businessVirtualCreditCard"
],
"type": "string",
"default": "businessVirtualCreditCard"
},
"attributes": {
"type": "object",
"required": [
"address",
"fullName",
"phone",
"email",
"dateOfBirth"
],
"properties": {
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"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"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"limits": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessDebitCard/properties/attributes/properties/limits"
},
"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"
},
"passport": {
"type": "string"
},
"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])$"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
}
}
},
"relationships": {
"$ref": "#/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCardRelationships"
}
}
},
"CreateIndividualVirtualDebitCard": {
"type": "object",
"title": "Create Individual Virtual Debit Card",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"enum": [
"individualVirtualDebitCard"
],
"type": "string",
"default": "individualVirtualDebitCard"
},
"attributes": {
"type": "object",
"properties": {
"bin": {
"$ref": "#/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/BIN"
},
"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"
},
"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])$"
},
"cardQualifier": {
"type": "string",
"pattern": "^\\d{3}$"
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
}
}
},
"relationships": {
"$ref": "#/paths/~1cards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCardRelationships"
}
}
}
}
}
CreateACardViaApiResponse
{
"type": "object",
"title": "UnitCardResponse",
"properties": {
"data": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
CreateADocumentForAnApplicationViaApiResponse
{
"type": "object",
"title": "UnitDocumentResponse",
"properties": {
"data": {
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/included/items"
}
}
}
CreateAPaymentViaApiRequest
{
"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"
}
]
}
},
"definitions": {
"CreateAchPayment": {
"type": "object",
"title": "Create ACH Payment to inline Counterparty",
"required": [
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "achPayment"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description",
"direction",
"counterparty"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"addenda": {
"type": "string"
},
"sameDay": {
"type": "boolean"
},
"secCode": {
"enum": [
"WEB",
"CCD",
"PPD"
],
"type": "string"
},
"direction": {
"enum": [
"Debit",
"Credit"
],
"type": "string"
},
"description": {
"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"
},
"idempotencyKey": {
"type": "string"
}
}
},
"relationships": {
"type": "object",
"required": [
"account"
],
"properties": {
"account": {
"$ref": "#/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship"
}
}
}
}
},
"CreateBillPayment": {
"type": "object",
"title": "Create Bill Payment",
"required": [
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "billPayment"
},
"attributes": {
"type": "object",
"required": [
"billerId",
"accountNumber",
"amount",
"description"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"billerId": {
"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"
},
"description": {
"type": "string"
},
"accountNumber": {
"type": "string"
},
"idempotencyKey": {
"type": "string"
}
}
},
"relationships": {
"type": "object",
"required": [
"account"
],
"properties": {
"account": {
"$ref": "#/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship"
}
}
}
}
},
"CreateBookPayment": {
"type": "object",
"title": "Create Book Payment",
"required": [
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "bookPayment"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"description": {
"type": "string"
},
"idempotencyKey": {
"type": "string"
},
"transactionSummaryOverride": {
"type": "string"
}
}
},
"relationships": {
"type": "object",
"required": [
"account",
"counterpartyAccount"
],
"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"
}
}
}
}
},
"CreateWirePayment": {
"type": "object",
"title": "Create Wire Payment",
"required": [
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "wirePayment"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description",
"counterparty"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"direction": {
"enum": [
"Credit"
],
"type": "string"
},
"description": {
"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/wireCounterparty"
},
"idempotencyKey": {
"type": "string"
}
}
},
"relationships": {
"type": "object",
"required": [
"account"
],
"properties": {
"account": {
"$ref": "#/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship"
}
}
}
}
},
"accountRelationship": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"account",
"depositAccount",
"creditAccount",
"batchAccount"
],
"type": "string"
}
}
}
}
},
"additionalProperties": false,
"CreateAchPaymentPlaid": {
"type": "object",
"title": "Create ACH Payment with Plaid token",
"required": [
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "achPayment"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description",
"direction",
"plaidProcessorToken"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"addenda": {
"type": "string"
},
"sameDay": {
"type": "boolean"
},
"secCode": {
"enum": [
"WEB",
"CCD",
"PPD"
],
"type": "string"
},
"direction": {
"enum": [
"Debit",
"Credit"
],
"type": "string"
},
"description": {
"type": "string"
},
"idempotencyKey": {
"type": "string"
},
"counterpartyName": {
"type": "string"
},
"plaidProcessorToken": {
"type": "string",
"pattern": "^processor-.*$"
},
"verifyCounterpartyBalance": {
"type": "boolean",
"default": false
}
}
},
"relationships": {
"type": "object",
"required": [
"account"
],
"properties": {
"account": {
"$ref": "#/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship"
}
}
}
}
},
"CreatePushToCardPayment": {
"type": "object",
"title": "Create Push To Card Payment",
"required": [
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "pushToCardPayment"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description",
"configuration"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"description": {
"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"
}
}
},
"idempotencyKey": {
"type": "string"
}
}
},
"relationships": {
"type": "object",
"required": [
"account"
],
"properties": {
"account": {
"$ref": "#/paths/~1payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship"
}
}
}
}
},
"counterpartyRelationship": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"account",
"depositAccount",
"counterparty"
],
"type": "string"
}
}
}
}
},
"CreateAchPaymentCounterparty": {
"type": "object",
"title": "Create ACH Payment to linked Counterparty",
"required": [
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "achPayment"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description",
"direction"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"addenda": {
"type": "string"
},
"sameDay": {
"type": "boolean"
},
"secCode": {
"enum": [
"WEB",
"CCD",
"PPD"
],
"type": "string"
},
"direction": {
"enum": [
"Debit",
"Credit"
],
"type": "string"
},
"description": {
"type": "string"
},
"idempotencyKey": {
"type": "string"
},
"verifyCounterpartyBalance": {
"type": "boolean",
"default": false
}
}
},
"relationships": {
"type": "object",
"required": [
"account",
"counterparty"
],
"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"
}
}
}
}
},
"counterpartyAccountRelationship": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"account",
"depositAccount"
],
"type": "string"
}
}
}
}
}
}
}
CreateARepaymentViaApiRequest
{
"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"
}
]
}
},
"definitions": {
"CreateAchRepayment": {
"type": "object",
"title": "Create ACH Repayment",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "achRepayment"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"addenda": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"sameDay": {
"type": "boolean"
},
"description": {
"type": "string",
"maxLength": 10,
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
}
}
},
"relationships": {
"type": "object",
"required": [
"account",
"creditAccount",
"counterparty"
],
"properties": {
"account": {
"$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"
},
"creditAccount": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
}
}
}
}
},
"CreateBookRepayment": {
"type": "object",
"title": "Create Book Repayment",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "bookRepayment"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"description": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"transactionSummaryOverride": {
"type": "string",
"maxLength": 100,
"minLength": 1
}
}
},
"relationships": {
"type": "object",
"required": [
"account",
"creditAccount",
"counterpartyAccount"
],
"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"
}
}
}
}
}
}
}
CreateARepaymentViaApiResponse
{
"type": "object",
"title": "UnitRepaymentResponse",
"properties": {
"data": {
"$ref": "#/paths/~1repayments/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items"
}
}
}
CreateAccountViaApiRequest
{
"type": "object",
"required": [
"data"
],
"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"
}
]
}
},
"definitions": {
"CreateCreditAccount": {
"type": "object",
"title": "Create Credit Account",
"properties": {
"type": {
"enum": [
"creditAccount"
],
"type": "string",
"default": "creditAccount"
},
"attributes": {
"type": "object",
"required": [
"creditTerms",
"creditLimit"
],
"properties": {
"tags": {
"type": "object",
"nullable": true
},
"creditLimit": {
"type": "integer"
},
"creditTerms": {
"type": "string"
},
"idempotencyKey": {
"type": "string",
"nullable": true
}
}
},
"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": {
"type": "object",
"title": "Create Deposit Account",
"properties": {
"type": {
"enum": [
"depositAccount"
],
"type": "string",
"default": "depositAccount"
},
"attributes": {
"type": "object",
"required": [
"depositProduct"
],
"properties": {
"tags": {
"type": "object",
"nullable": true
},
"depositProduct": {
"type": "string"
},
"idempotencyKey": {
"type": "string",
"nullable": true
}
}
},
"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": {
"type": "object",
"title": "Customers Relationship",
"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"
}
}
}
}
}
}
}
}
}
}
}
}
CreateApplicationFormViaApiRequest
{
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"default": "applicationForm"
},
"attributes": {
"type": "object",
"properties": {
"lang": {
"enum": [
"en",
"es"
],
"type": "string"
},
"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": {
"enum": [
"Individual",
"Business",
"SoleProprietorship"
],
"type": "string"
}
},
"hideApplicationProgressTracker": {
"type": "boolean"
}
}
},
"relationships": {
"type": "object",
"title": "createApplicationFormRelationships",
"required": [],
"properties": {
"application": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
}
}
}
}
}
},
"definitions": {
"requireIdVerification": {
"type": "object",
"properties": {
"officer": {
"type": "boolean",
"default": false
},
"individual": {
"type": "boolean",
"default": false
},
"beneficialOwners": {
"type": "boolean",
"default": false
}
}
}
}
}
CreateApplicationFormViaApiResponse
{
"type": "object",
"title": "UnitApplicationFormResponse",
"properties": {
"data": {
"type": "object",
"title": "Application Form",
"required": [
"type",
"id",
"attributes"
],
"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": "applicationForm"
},
"attributes": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string"
},
"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"
},
"stage": {
"enum": [
"ChooseBusinessOrIndividual",
"EnterIndividualInformation",
"IndividualPhoneVerification",
"IndividualApplicationCreated",
"EnterBusinessInformation",
"EnterBusinessAdditionalInformation",
"EnterOfficerInformation",
"BusinessPhoneVerification",
"EnterBeneficialOwnersInformation",
"BusinessApplicationCreated",
"EnterSoleProprietorshipInformation",
"EnterSoleProprietorshipBusinessInformation",
"SoleProprietorshipPhoneVerification",
"SoleProprietorshipApplicationCreated"
],
"type": "string"
},
"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": {
"enum": [
"Individual",
"Business",
"SoleProprietorship"
],
"type": "string"
}
}
}
},
"relationships": {
"$ref": "#/paths/~1application-forms/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/applicationFormRelationships"
}
},
"definitions": {
"ApplicationFormPrefill": {
"type": "object",
"title": "Application Form Prefilled",
"properties": {
"dba": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"ein": {
"type": "string",
"pattern": "^\\d{9}$"
},
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"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"
},
"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"
},
"website": {
"type": "string"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"industry": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/industry"
},
"passport": {
"type": "string"
},
"entityType": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/entityType"
},
"jwtSubject": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent/properties/jwtSubject"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"applicationType": {
"enum": [
"Individual",
"Business",
"SoleProprietorship"
],
"type": "string"
},
"beneficialOwners": {
"type": "array",
"items": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createBeneficialOwner"
}
},
"stateOfIncorporation": {
"type": "string",
"maxLength": 2,
"minLength": 2
}
}
},
"applicationFormRelationships": {
"type": "object",
"title": "applicationFormRelationships",
"required": [],
"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": {
"enum": [
"application"
],
"type": "string"
}
}
}
}
}
}
},
"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"
},
"clientTermsUrl": {
"$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"
},
"privacyPolicyUrl": {
"$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"
},
"additionalDisclosures": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/attributes/properties/link"
},
"title": {
"type": "string"
}
}
}
},
"debitCardDisclosureUrl": {
"$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"
}
}
}
}
}
}
}
CreateApplicationViaApiRequest
{
"type": "object",
"required": [
"data"
],
"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"
}
]
}
},
"definitions": {
"createOfficer": {
"type": "object",
"title": "CreateOfficer",
"required": [
"fullName",
"email",
"phone",
"address",
"dateOfBirth",
"occupation"
],
"properties": {
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"email": {
"type": "string",
"format": "email"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"title": {
"enum": [
"President",
"CEO",
"COO",
"CFO",
"BenefitsAdministrationOfficer",
"CIO",
"VP",
"AVP",
"Treasurer",
"Secretary",
"Controller",
"Manager",
"Partner",
"Member"
],
"type": "string"
},
"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"
},
"passport": {
"type": "string"
},
"occupation": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/occupation"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"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"
},
"evaluationParams": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/evaluationParams"
},
"matriculaConsular": {
"type": "string"
}
}
},
"evaluationParams": {
"type": "object",
"title": "EvaluationParams",
"properties": {
"requireIdVerification": {
"type": "boolean",
"default": false
},
"useSelfieVerification": {
"enum": [
"Never",
"ReplaceIdentification",
"Always"
],
"type": "string"
}
}
},
"createBeneficialOwner": {
"type": "object",
"title": "CreateBeneficialOwner",
"required": [
"fullName",
"email",
"phone",
"address",
"dateOfBirth"
],
"properties": {
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"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"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"passport": {
"type": "string"
},
"occupation": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/occupation"
},
"percentage": {
"type": "integer",
"maximum": 100,
"minimum": 0
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"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"
},
"evaluationParams": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/evaluationParams"
},
"matriculaConsular": {
"type": "string"
}
}
},
"CreateTrustApplication": {
"type": "object",
"title": "Create Trust Application",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"default": "trustApplication"
},
"attributes": {
"type": "object",
"required": [
"name",
"stateOfIncorporation",
"revocability",
"sourceOfFunds",
"taxId",
"grantor",
"trustees",
"beneficiaries",
"contact"
],
"properties": {
"ip": {
"type": "string"
},
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"taxId": {
"type": "string"
},
"contact": {
"type": "object",
"title": "TrustContact",
"properties": {
"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"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"jwtSubject": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent/properties/jwtSubject"
}
}
},
"grantor": {
"type": "object",
"title": "Grantor",
"required": [
"fullName",
"email",
"phone",
"address",
"dateOfBirth"
],
"properties": {
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"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"
},
"status": {
"type": "string"
},
"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"
},
"passport": {
"type": "string"
},
"maskedSSN": {
"type": "string",
"pattern": "^\\*{5}\\d{4}$"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"evaluationId": {
"type": "string"
},
"evaluationFlags": {
"type": "array",
"items": {
"type": "string"
}
},
"matriculaConsular": {
"type": "string"
}
}
},
"trustees": {
"type": "array",
"items": {
"type": "object",
"title": "Trustee",
"required": [
"fullName",
"email",
"phone",
"address",
"dateOfBirth"
],
"properties": {
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"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"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"passport": {
"type": "string"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"matriculaConsular": {
"type": "string"
}
}
}
},
"revocability": {
"enum": [
"Revocable",
"Irrevocable"
],
"type": "string"
},
"beneficiaries": {
"type": "array",
"items": {
"type": "object",
"title": "Beneficiary",
"required": [
"fullName",
"dateOfBirth"
],
"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"
}
}
}
},
"sourceOfFunds": {
"enum": [
"Inheritance",
"Salary",
"Savings",
"InvestmentReturns",
"Gifts"
],
"type": "string"
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"deviceFingerprints": {
"type": "array",
"items": {
"type": "object",
"required": [
"provider",
"value"
],
"properties": {
"value": {
"type": "string"
},
"provider": {
"enum": [
"iovation"
],
"type": "string"
}
}
},
"maxItems": 1
},
"stateOfIncorporation": {
"type": "string",
"maxLength": 2,
"minLength": 2
}
}
}
}
},
"CreateBusinessApplication": {
"type": "object",
"title": "Create Business Application",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"default": "businessApplication"
},
"attributes": {
"type": "object",
"required": [
"name",
"ein",
"entityType",
"stateOfIncorporation",
"phone",
"address",
"contact",
"officer",
"beneficialOwners"
],
"properties": {
"ip": {
"type": "string"
},
"dba": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"ein": {
"type": "string",
"pattern": "^\\d{9}$"
},
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"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": {
"type": "object",
"title": "Contact",
"properties": {
"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"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"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"
},
"purpose": {
"type": "string",
"maxLength": 1024,
"minLength": 1
},
"website": {
"type": "string"
},
"cashFlow": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/cashFlow"
},
"industry": {
"enum": [
"Retail",
"Wholesale",
"Restaurants",
"Hospitals",
"Construction",
"Insurance",
"Unions",
"RealEstate",
"FreelanceProfessional",
"OtherProfessionalServices",
"OnlineRetailer",
"OtherEducationServices"
],
"type": "string"
},
"entityType": {
"enum": [
"Corporation",
"LLC",
"Partnership",
"PubliclyTradedCorporation",
"PrivatelyHeldCorporation",
"NotForProfitOrganization"
],
"type": "string"
},
"stockSymbol": {
"type": "string",
"maxLength": 5,
"minLength": 1
},
"annualRevenue": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/annualRevenue"
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"beneficialOwners": {
"type": "array",
"items": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createBeneficialOwner"
}
},
"businessVertical": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/businessVertical"
},
"numberOfEmployees": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/numberOfEmployees"
},
"deviceFingerprints": {
"type": "array",
"items": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateTrustApplication/properties/attributes/properties/deviceFingerprints/items"
},
"maxItems": 1
},
"dateOfIncorporation": {
"type": "string",
"format": "date"
},
"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
},
"stateOfIncorporation": {
"type": "string",
"maxLength": 2,
"minLength": 2
}
}
}
}
},
"createPowerOfAttorneyAgent": {
"type": "object",
"title": "CreatePowerOfAttorneyAgent",
"required": [
"fullName",
"email",
"phone",
"address",
"dateOfBirth"
],
"properties": {
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"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"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"passport": {
"type": "string"
},
"jwtSubject": {
"type": "string",
"nullable": true
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"evaluationParams": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/evaluationParams"
},
"matriculaConsular": {
"type": "string"
}
}
},
"CreateIndividualApplication": {
"type": "object",
"title": "Create Individual Application",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"default": "individualApplication"
},
"attributes": {
"type": "object",
"required": [
"fullName",
"email",
"phone",
"address",
"dateOfBirth"
],
"properties": {
"ip": {
"type": "string"
},
"ssn": {
"type": "string",
"pattern": "^\\d{9}|\\d{4}",
"nullable": true
},
"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"
},
"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"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"industry": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/industry"
},
"passport": {
"type": "string",
"nullable": true
},
"jwtSubject": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent/properties/jwtSubject"
},
"occupation": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/occupation"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/components/schemas/nationalityNullable"
},
"annualIncome": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/annualIncome"
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"sourceOfIncome": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/sourceOfIncome"
},
"evaluationParams": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/evaluationParams"
},
"deviceFingerprints": {
"type": "array",
"items": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateTrustApplication/properties/attributes/properties/deviceFingerprints/items"
},
"maxItems": 1
},
"powerOfAttorneyAgent": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent"
}
}
}
}
},
"CreateSoleProprietorApplication": {
"type": "object",
"title": "Create Sole Proprietor Application",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"default": "individualApplication"
},
"attributes": {
"type": "object",
"required": [
"fullName",
"email",
"phone",
"address",
"dateOfBirth"
],
"properties": {
"ip": {
"type": "string"
},
"dba": {
"type": "string",
"nullable": true
},
"ein": {
"type": "string",
"pattern": "^\\d{9}$",
"nullable": true
},
"ssn": {
"type": "string",
"pattern": "^\\d{9}|\\d{4}",
"nullable": true
},
"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"
},
"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"
},
"website": {
"type": "string"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"industry": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/industry"
},
"passport": {
"type": "string",
"nullable": true
},
"jwtSubject": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent/properties/jwtSubject"
},
"occupation": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/occupation"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/components/schemas/nationalityNullable"
},
"annualIncome": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/annualIncome"
},
"annualRevenue": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchSoleProprietorApplication/properties/attributes/properties/annualRevenue"
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"sourceOfIncome": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/sourceOfIncome"
},
"businessVertical": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/businessVertical"
},
"evaluationParams": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/evaluationParams"
},
"matriculaConsular": {
"type": "string",
"nullable": true
},
"numberOfEmployees": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchSoleProprietorApplication/properties/attributes/properties/numberOfEmployees"
},
"deviceFingerprints": {
"type": "array",
"items": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateTrustApplication/properties/attributes/properties/deviceFingerprints/items"
},
"maxItems": 1
},
"soleProprietorship": {
"type": "boolean",
"default": false
},
"powerOfAttorneyAgent": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent"
}
}
}
}
}
}
}
CreateApplicationViaApiResponse
{
"type": "object",
"title": "UnitCreateApplicationResponse",
"properties": {
"data": {
"type": "object",
"title": "Application",
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string"
}
},
"definitions": {
"officer": {
"type": "object",
"title": "Officer",
"properties": {
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"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"
},
"title": {
"enum": [
"President",
"CEO",
"COO",
"CFO",
"BenefitsAdministrationOfficer",
"CIO",
"VP",
"AVP",
"Treasurer",
"Secretary",
"Controller",
"Manager",
"Partner",
"Member"
],
"type": "string"
},
"status": {
"type": "string"
},
"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"
},
"passport": {
"type": "string"
},
"maskedSSN": {
"type": "string",
"pattern": "^\\*{5}\\d{4}$"
},
"occupation": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/occupation"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"annualIncome": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/annualIncome"
},
"evaluationId": {
"type": "string"
},
"idTheftScore": {
"type": "integer"
},
"maskedPassport": {
"type": "string"
},
"sourceOfIncome": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/sourceOfIncome"
},
"evaluationFlags": {
"type": "array",
"items": {
"type": "string"
}
},
"matriculaConsular": {
"type": "string"
},
"maskedMatriculaConsular": {
"type": "string"
}
}
},
"beneficialOwner": {
"type": "object",
"title": "Beneficial Owner",
"properties": {
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"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"
},
"status": {
"type": "string"
},
"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"
},
"passport": {
"type": "string"
},
"maskedSSN": {
"type": "string",
"pattern": "^\\*{5}\\d{4}$"
},
"occupation": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/occupation"
},
"percentage": {
"type": "integer",
"maximum": 100,
"minimum": 0
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"annualIncome": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/annualIncome"
},
"evaluationId": {
"type": "string"
},
"idTheftScore": {
"type": "integer"
},
"maskedPassport": {
"type": "string"
},
"sourceOfIncome": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/sourceOfIncome"
},
"evaluationCodes": {
"type": "array",
"items": {
"type": "string"
}
},
"evaluationFlags": {
"type": "array",
"items": {
"type": "string"
}
},
"matriculaConsular": {
"type": "string"
},
"maskedMatriculaConsular": {
"type": "string"
}
}
},
"TrustApplication": {
"type": "object",
"allOf": [
{
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data"
},
{
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"status",
"name",
"stateOfIncorporation",
"contact"
],
"properties": {
"ip": {
"type": "string"
},
"name": {
"type": "string"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"taxId": {
"type": "string"
},
"status": {
"enum": [
"AwaitingDocuments",
"PendingReview",
"Approved",
"Denied",
"Pending",
"Canceled"
],
"type": "string"
},
"contact": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateTrustApplication/properties/attributes/properties/contact"
},
"grantor": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateTrustApplication/properties/attributes/properties/grantor"
},
"message": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"riskRate": {
"enum": [
"low",
"medium",
"high"
],
"type": "string"
},
"trustees": {
"type": "array",
"items": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateTrustApplication/properties/attributes/properties/trustees/items"
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"evaluationId": {
"type": "string"
},
"revocability": {
"enum": [
"Revocable",
"Irrevocable"
],
"type": "string"
},
"sourceOfFunds": {
"enum": [
"Inheritance",
"Salary",
"Savings",
"InvestmentReturns",
"Gifts"
],
"type": "string"
},
"decisionMethod": {
"enum": [
"Manually",
"Automatically"
],
"type": "string"
},
"decisionReason": {
"type": "string"
},
"decisionUserId": {
"type": "string"
},
"evaluationFlags": {
"type": "array",
"items": {
"type": "string"
}
},
"decisionDateTime": {
"type": "string",
"format": "date-time"
},
"evaluationOutcome": {
"type": "string"
},
"ipLocationDetails": {
"type": "object"
},
"evaluationEntityId": {
"type": "string"
},
"dateOfIncorporation": {
"type": "string",
"format": "date"
},
"phoneLocationDetails": {
"type": "object"
},
"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]))$"
}
}
},
"relationships": {
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/applicationRelationships"
}
}
}
],
"title": "TrustApplication"
},
"BusinessApplication": {
"type": "object",
"allOf": [
{
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data"
},
{
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"status",
"name",
"entityType",
"stateOfIncorporation",
"contact",
"officer",
"beneficialOwners"
],
"properties": {
"ip": {
"type": "string"
},
"dba": {
"type": "string",
"nullable": true
},
"ein": {
"type": "string",
"pattern": "^\\d{9}$"
},
"name": {
"type": "string"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"status": {
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/TrustApplication/allOf/1/properties/attributes/properties/status"
},
"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"
},
"message": {
"type": "string"
},
"officer": {
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/officer"
},
"purpose": {
"type": "string"
},
"website": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"cashFlow": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/cashFlow"
},
"industry": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/industry"
},
"riskRate": {
"enum": [
"low",
"medium",
"high"
],
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"entityType": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/entityType"
},
"stockSymbol": {
"type": "string"
},
"evaluationId": {
"type": "string"
},
"annualRevenue": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/annualRevenue"
},
"decisionMethod": {
"enum": [
"Manually",
"Automatically"
],
"type": "string"
},
"decisionReason": {
"type": "string"
},
"decisionUserId": {
"type": "string"
},
"evaluationFlags": {
"type": "array",
"items": {
"type": "string"
}
},
"beneficialOwners": {
"type": "array",
"items": {
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/beneficialOwner"
}
},
"businessVertical": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/businessVertical"
},
"decisionDateTime": {
"type": "string",
"format": "date-time"
},
"evaluationOutcome": {
"type": "string"
},
"ipLocationDetails": {
"type": "object"
},
"numberOfEmployees": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/numberOfEmployees"
},
"evaluationEntityId": {
"type": "string"
},
"dateOfIncorporation": {
"type": "string",
"format": "date"
},
"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
},
"phoneLocationDetails": {
"type": "object"
},
"stateOfIncorporation": {
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/TrustApplication/allOf/1/properties/attributes/properties/stateOfIncorporation"
}
}
},
"relationships": {
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/applicationRelationships"
}
}
}
],
"title": "BusinessApplication"
},
"powerOfAttorneyAgent": {
"type": "object",
"title": "PowerOfAttorneyAgent",
"required": [
"status",
"fullName"
],
"properties": {
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"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"
},
"status": {
"type": "string"
},
"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"
},
"passport": {
"type": "string"
},
"maskedSSN": {
"type": "string",
"pattern": "^\\*{5}\\d{4}$"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"evaluationId": {
"type": "string"
},
"idTheftScore": {
"type": "integer"
},
"maskedPassport": {
"type": "string"
},
"evaluationFlags": {
"type": "array",
"items": {
"type": "string"
}
},
"matriculaConsular": {
"type": "string"
},
"maskedMatriculaConsular": {
"type": "string"
}
}
},
"IndividualApplication": {
"type": "object",
"allOf": [
{
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data"
},
{
"type": "object",
"required": [
"id",
"type",
"attributes"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"status",
"fullName"
],
"properties": {
"ip": {
"type": "string"
},
"dba": {
"type": "string"
},
"ein": {
"type": "string",
"pattern": "^\\d{9}$"
},
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"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"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"status": {
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/TrustApplication/allOf/1/properties/attributes/properties/status"
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"message": {
"type": "string"
},
"website": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"industry": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/industry"
},
"passport": {
"type": "string"
},
"riskRate": {
"enum": [
"low",
"medium",
"high"
],
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"maskedSSN": {
"type": "string",
"pattern": "^\\*{5}\\d{4}$"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"jwtSubject": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent/properties/jwtSubject"
},
"occupation": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/occupation"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"annualIncome": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/annualIncome"
},
"evaluationId": {
"type": "string"
},
"idTheftScore": {
"type": "integer"
},
"annualRevenue": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchSoleProprietorApplication/properties/attributes/properties/annualRevenue"
},
"decisionMethod": {
"enum": [
"Manually",
"Automatically"
],
"type": "string"
},
"decisionReason": {
"type": "string"
},
"decisionUserId": {
"type": "string"
},
"maskedPassport": {
"type": "string"
},
"sourceOfIncome": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/sourceOfIncome"
},
"evaluationFlags": {
"type": "array",
"items": {
"type": "string"
}
},
"businessVertical": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/businessVertical"
},
"decisionDateTime": {
"type": "string",
"format": "date-time"
},
"evaluationScores": {
"type": "object"
},
"evaluationOutcome": {
"type": "string"
},
"ipLocationDetails": {
"type": "object"
},
"matriculaConsular": {
"type": "string"
},
"numberOfEmployees": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchSoleProprietorApplication/properties/attributes/properties/numberOfEmployees"
},
"evaluationEntityId": {
"type": "string"
},
"soleProprietorship": {
"type": "boolean"
},
"phoneLocationDetails": {
"type": "object"
},
"powerOfAttorneyAgent": {
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/powerOfAttorneyAgent"
},
"maskedMatriculaConsular": {
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/applicationRelationships"
}
}
}
],
"title": "IndividualApplication"
},
"applicationRelationships": {
"type": "object",
"title": "applicationRelationships",
"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"
},
"trustees": {
"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": "trustee"
}
}
}
}
}
},
"documents": {
"type": "object",
"title": "documentsRelationship",
"required": [
"data"
],
"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": "document"
}
}
}
}
},
"additionalProperties": true
},
"beneficiaries": {
"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": "beneficiary"
}
}
}
}
}
},
"applicationForm": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
},
"beneficialOwners": {
"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": "beneficialOwner"
}
}
}
}
}
}
}
}
},
"discriminator": {
"mapping": {
"trustApplication": "#/definitions/TrustApplication",
"businessApplication": "#/definitions/BusinessApplication",
"individualApplication": "#/definitions/IndividualApplication"
},
"propertyName": "type"
}
},
"included": {
"type": "array",
"items": {
"type": "object",
"title": "Application Document Document",
"required": [
"type",
"id",
"attributes"
],
"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": "document"
},
"attributes": {
"type": "object",
"required": [
"status"
],
"properties": {
"ein": {
"type": "string",
"pattern": "^\\d{9}$"
},
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"name": {
"type": "string"
},
"reason": {
"type": "string"
},
"status": {
"type": "string"
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"passport": {
"type": "string"
},
"reasonCode": {
"type": "string"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"description": {
"type": "string"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"documentType": {
"type": "string"
},
"evaluationId": {
"type": "string"
},
"backDocumentId": {
"type": "string"
},
"frontDocumentId": {
"type": "string"
},
"matriculaConsular": {
"type": "string"
},
"backDocumentStoreId": {
"type": "string"
},
"dateOfIncorporation": {
"type": "string",
"format": "date"
},
"frontDocumentStoreId": {
"type": "string"
},
"stateOfIncorporation": {
"type": "string"
}
}
}
}
}
}
}
}
CreateCheckDepositViaApiRequest
{
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"enum": [
"checkDeposit"
],
"type": "string",
"default": "checkDeposit"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"description": {
"type": "string",
"maxLength": 50,
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
}
}
},
"relationships": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships"
}
}
}
},
"definitions": {
"createCheckDepositRelationships": {
"type": "object",
"required": [
"account"
],
"properties": {
"account": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string"
}
}
}
}
}
}
}
}
}
CreateCheckDepositViaApiResponse
{
"type": "object",
"title": "UnitCheckDepositResponse",
"properties": {
"data": {
"type": "object",
"title": "Check Deposit",
"required": [
"type",
"id",
"attributes",
"relationships"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"checkDeposit"
],
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"description",
"status"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"reason": {
"type": "string",
"nullable": true
},
"status": {
"enum": [
"AwaitingImages",
"AwaitingFrontImage",
"AwaitingBackImage",
"Pending",
"PendingReview",
"AwaitingCustomerConfirmation",
"Rejected",
"Clearing",
"Sent",
"Canceled",
"Returned"
],
"type": "string"
},
"vendor": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"reasonText": {
"type": "string"
},
"checkNumber": {
"type": "string"
},
"description": {
"type": "string",
"maxLength": 50,
"minLength": 1
},
"statusSetBy": {
"type": "string"
},
"counterparty": {
"$ref": "#/paths/~1check-deposits/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/counterparty"
},
"statusHistory": {
"type": "array",
"items": {
"$ref": "#/paths/~1check-deposits/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/statusEvent"
}
},
"settlementDate": {
"type": "string",
"format": "date"
},
"statusCreatedAt": {
"type": "string",
"format": "date-time"
}
}
},
"relationships": {
"$ref": "#/paths/~1check-deposits/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/checkDepositRelationships"
}
},
"definitions": {
"statusEvent": {
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"type": "object",
"properties": {
"type": {
"$ref": "#/paths/~1check-deposits/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/checkDepositStatus"
}
}
},
"updatedAt": {
"type": "string"
},
"updatedBy": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
}
}
},
"counterparty": {
"type": "object",
"title": "Counterparty",
"required": [
"routingNumber",
"accountNumber",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 250,
"minLength": 1
},
"accountNumber": {
"type": "string",
"maxLength": 17
},
"routingNumber": {
"type": "string",
"pattern": "^\\d{9}$"
}
}
},
"checkDepositStatus": {
"enum": [
"AwaitingImages",
"AwaitingFrontImage",
"AwaitingBackImage",
"AwaitingCustomerConfirmation",
"Pending",
"PendingReview",
"Rejected",
"Clearing",
"Sent",
"Canceled",
"Returned"
],
"type": "string"
},
"checkDepositRelationships": {
"type": "object",
"title": "checkDepositRelationships",
"required": [
"account"
],
"properties": {
"org": {
"$ref": "#/paths/~1customers~1%7BcustomerId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/relationships/properties/org"
},
"account": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"account",
"depositAccount",
"batchAccount"
],
"type": "string"
}
}
}
},
"additionalProperties": true
},
"customer": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"businessCustomer",
"individualCustomer",
"customer"
],
"type": "string"
}
}
}
}
},
"transaction": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "transaction"
}
}
}
}
}
}
}
}
}
}
}
CreateCheckPaymentViaApiRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/paths/~1check-payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/checkPayment"
}
},
"definitions": {
"checkPayment": {
"type": "object",
"title": "Check Payment",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "checkPayment"
},
"attributes": {
"type": "object",
"required": [
"counterparty",
"amount",
"idempotencyKey",
"description"
],
"properties": {
"memo": {
"type": "string"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"sendDate": {
"type": "string",
"format": "date"
},
"description": {
"type": "string",
"maxLength": 50,
"minLength": 1
},
"counterparty": {
"type": "object",
"required": [
"name",
"address"
],
"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"
}
}
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
}
}
},
"relationships": {
"$ref": "#/paths/~1check-payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/relationships"
}
}
},
"relationships": {
"type": "object",
"required": [
"account",
"customer"
],
"properties": {
"account": {
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"account",
"depositAccount"
],
"type": "string"
}
}
}
}
},
"customer": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"businessCustomer",
"individualCustomer"
],
"type": "string"
}
}
}
}
}
}
}
}
}
CreateCheckPaymentViaApiResponse
{
"type": "object",
"title": "UnitCheckPaymentResponse",
"properties": {
"data": {
"$ref": "#/paths/~1check-payments/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items"
}
}
}
CreateCounterpartyViaApiRequest
{
"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"
}
]
}
},
"definitions": {
"CreateAchCounterparty": {
"type": "object",
"title": "Create Ach Counterparty",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"type",
"name",
"accountType",
"accountNumber",
"routingNumber"
],
"properties": {
"name": {
"type": "string"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"type": {
"enum": [
"Business",
"Person",
"Unknown"
],
"type": "string"
},
"accountType": {
"enum": [
"Checking",
"Savings",
"Loan"
],
"type": "string"
},
"permissions": {
"enum": [
"CreditOnly",
"DebitOnly",
"CreditAndDebit"
],
"type": "string"
},
"accountNumber": {
"type": "string"
},
"routingNumber": {
"type": "string"
},
"idempotencyKey": {
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1counterparties/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCounterpartyRelationships"
}
}
},
"CreatePlaidCounterparty": {
"type": "object",
"title": "Create Plaid Counterparty",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"type",
"plaidProcessorToken"
],
"properties": {
"name": {
"type": "string"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"type": {
"enum": [
"Business",
"Person",
"Unknown"
],
"type": "string"
},
"verifyName": {
"type": "boolean",
"default": false
},
"permissions": {
"enum": [
"CreditOnly",
"DebitOnly",
"CreditAndDebit"
],
"type": "string"
},
"idempotencyKey": {
"type": "string"
},
"plaidProcessorToken": {
"$ref": "#/paths/~1counterparties~1%7BcounterpartyId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchCounterparty/properties/attributes/properties/plaidProcessorToken"
}
}
},
"relationships": {
"$ref": "#/paths/~1counterparties/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCounterpartyRelationships"
}
}
},
"createCounterpartyRelationships": {
"type": "object",
"required": [
"customer"
],
"properties": {
"customer": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
}
}
}
}
}
CreateCounterpartyViaApiResponse
{
"type": "object",
"title": "UnitCounterpartyResponse",
"properties": {
"data": {
"type": "object",
"title": "Counterparty Document",
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"routingNumber",
"accountNumber",
"accountType",
"type",
"name",
"createdAt",
"permissions"
],
"properties": {
"bank": {
"type": "string"
},
"name": {
"type": "string",
"maxLength": 50,
"minLength": 1
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"type": {
"enum": [
"Business",
"Person",
"Unknown"
],
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"accountType": {
"enum": [
"Checking",
"Savings",
"Loan"
],
"type": "string"
},
"permissions": {
"enum": [
"CreditOnly",
"DebitOnly",
"CreditAndDebit"
],
"type": "string"
},
"accountNumber": {
"type": "string",
"pattern": "^\\d{1,17}$"
},
"routingNumber": {
"type": "string",
"pattern": "^\\d{9}$"
}
}
},
"relationships": {
"$ref": "#/paths/~1counterparties/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/counterpartyRelationships"
}
},
"definitions": {
"counterpartyRelationships": {
"type": "object",
"title": "counterpartyRelationships",
"required": [
"customer"
],
"properties": {
"customer": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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"
}
}
}
}
}
}
}
}
}
}
}
CreateCustomerTokenVerificationViaApiRequest
{
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"default": "customerTokenVerification"
},
"attributes": {
"type": "object",
"required": [
"channel"
],
"properties": {
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"appHash": {
"type": "string",
"maxLength": 11,
"minLength": 11
},
"channel": {
"enum": [
"sms",
"call"
],
"type": "string"
},
"language": {
"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"
],
"type": "string"
}
}
}
}
}
}
}
CreateCustomerTokenVerificationViaApiResponse
{
"type": "object",
"title": "UnitCustomerTokenVerificationResponse",
"properties": {
"data": {
"type": "object",
"title": "CustomerTokenVerification",
"required": [
"type",
"id",
"attributes"
],
"properties": {
"type": {
"type": "string",
"default": "customerTokenVerification"
},
"attributes": {
"type": "object",
"properties": {
"verificationToken": {
"type": "string"
}
}
}
}
}
}
}
CreateCustomerTokenViaApiRequest
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"default": "customerToken"
},
"attributes": {
"type": "object",
"properties": {
"scope": {
"type": "string"
},
"jwtToken": {
"type": "string"
},
"expiresIn": {
"type": "integer"
},
"resources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
}
},
"type": {
"enum": [
"card",
"account"
],
"type": "string"
}
}
},
"minItems": 1
},
"upgradableScope": {
"type": "string"
},
"verificationCode": {
"type": "string"
},
"verificationToken": {
"type": "string"
}
}
}
}
}
}
}
CreateCustomerTokenViaApiResponse
{
"type": "object",
"title": "UnitCustomerTokenResponse",
"properties": {
"data": {
"type": "object",
"title": "CustomerToken",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"default": "customerToken"
},
"attributes": {
"type": "object",
"properties": {
"token": {
"type": "string"
},
"expiresIn": {
"type": "integer"
}
}
}
}
}
}
}
CreateFeeViaApiRequest
{
"data": {
"type": "object",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"enum": [
"fee"
],
"type": "string",
"default": "fee"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description"
],
"properties": {
"tags": {
"type": "object",
"maxProperties": 15
},
"amount": {
"type": "integer",
"minimum": 1
},
"description": {
"type": "string",
"maxLength": 50
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
}
}
},
"relationships": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createFeeRelationships"
}
}
},
"type": "object",
"definitions": {
"createFeeRelationships": {
"type": "object",
"required": [
"account"
],
"properties": {
"account": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
}
}
}
}
}
CreateFeeViaApiResponse
{
"type": "object",
"title": "UnitFeeResponse",
"properties": {
"data": {
"type": "object",
"title": "Fee",
"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": "fee"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"description": {
"type": "string",
"maxLength": 50
}
}
},
"relationships": {
"$ref": "#/paths/~1fees/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/feeRelationships"
}
},
"definitions": {
"feeRelationships": {
"type": "object",
"title": "feeRelationships",
"required": [
"account"
],
"properties": {
"account": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
}
}
}
}
}
}
}
CreateOrgApiTokenViaApiRequest
{
"type": "object",
"title": "Create API Token",
"properties": {
"data": {
"type": "object",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"default": "apiToken"
},
"attributes": {
"type": "object",
"required": [
"description",
"expiration"
],
"properties": {
"scope": {
"type": "string"
},
"sourceIp": {
"type": "string"
},
"resources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
}
},
"type": {
"enum": [
"card",
"account"
],
"type": "string"
}
}
},
"minItems": 1
},
"expiration": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
}
}
}
}
}
}
}
CreateOrgApiTokenViaApiResponse
{
"type": "object",
"title": "UnitApiTokenResponse",
"properties": {
"data": {
"type": "object",
"title": "apiToken",
"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": "apiToken"
},
"attributes": {
"type": "object",
"required": [
"createdAt"
],
"properties": {
"token": {
"type": "string"
},
"sourceIp": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"expiration": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
}
}
}
}
}
}
}
CreateRecurringPaymentViaApiRequest
{
"type": "object",
"required": [
"data"
],
"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"
}
]
}
},
"definitions": {
"schedule": {
"oneOf": [
{
"$ref": "#/paths/~1recurring-payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/monthlySchedule"
}
],
"title": "schedule"
},
"monthlySchedule": {
"type": "object",
"title": "Create Monthly Schedule",
"required": [
"interval"
],
"properties": {
"endTime": {
"type": "string",
"format": "date"
},
"interval": {
"enum": [
"Monthly",
"Weekly"
],
"type": "string"
},
"dayOfWeek": {
"enum": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
],
"type": "string"
},
"startTime": {
"type": "string",
"format": "date"
},
"dayOfMonth": {
"type": "integer",
"maximum": 28,
"minimum": -5
},
"totalNumberOfPayments": {
"type": "integer",
"minimum": 1
}
}
},
"createRecurringDebitAchPayment": {
"type": "object",
"title": "Create Recurring Debit ACH Payment",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "recurringDebitAchPayment"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description",
"schedule"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"addenda": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"sameDay": {
"type": "boolean",
"default": false
},
"schedule": {
"$ref": "#/paths/~1recurring-payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/schedule"
},
"description": {
"type": "string",
"maxLength": 10,
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"clearingDaysOverride": {
"type": "integer",
"minimum": 0
},
"verifyCounterpartyBalance": {
"type": "boolean",
"default": false
}
}
},
"relationships": {
"type": "object",
"required": [
"account",
"counterparty"
],
"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"
}
}
}
}
},
"createRecurringCreditAchPayment": {
"type": "object",
"title": "Create Recurring Credit ACH Payment",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "recurringCreditAchPayment"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description",
"schedule"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"addenda": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"schedule": {
"$ref": "#/paths/~1recurring-payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/schedule"
},
"description": {
"type": "string",
"maxLength": 10,
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
}
}
},
"relationships": {
"type": "object",
"required": [
"account",
"counterparty"
],
"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"
}
}
}
}
},
"createRecurringCreditBookPayment": {
"type": "object",
"title": "Create Recurring Credit Book Payment",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "recurringCreditBookPayment"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description",
"schedule"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"schedule": {
"$ref": "#/paths/~1recurring-payments/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/schedule"
},
"description": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"transactionSummaryOverride": {
"type": "string",
"maxLength": 100,
"minLength": 1
}
}
},
"relationships": {
"type": "object",
"required": [
"account",
"counterpartyAccount"
],
"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"
}
}
}
}
}
}
}
CreateRecurringPaymentViaApiResponse
{
"type": "object",
"title": "UnitRecurringPaymentResponse",
"properties": {
"data": {
"$ref": "#/paths/~1recurring-payments/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items"
}
}
}
CreateRewardViaApiRequest
{
"type": "object",
"properties": {
"data": {
"type": "object",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "reward"
},
"attributes": {
"type": "object",
"required": [
"amount",
"description"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"description": {
"type": "string",
"maxLength": 50
},
"idempotencyKey": {
"type": "string",
"maxLength": 255,
"minLength": 1
}
}
},
"relationships": {
"$ref": "#/paths/~1rewards/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createRewardRelationships"
}
}
}
},
"definitions": {
"createRewardRelationships": {
"type": "object",
"required": [
"receivingAccount"
],
"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",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "transaction"
}
}
}
}
}
}
}
}
}
CreateRewardViaApiResponse
{
"type": "object",
"title": "UnitRewardResponse",
"properties": {
"data": {
"type": "object",
"title": "Reward",
"required": [
"type",
"id",
"relationships",
"attributes"
],
"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": "reward"
},
"attributes": {
"type": "object",
"required": [
"description",
"createdAt",
"amount",
"tags",
"status"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"status": {
"enum": [
"Rejected",
"Sent"
],
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string",
"maxLength": 50
},
"rejectReason": {
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1rewards/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/rewardRelationships"
}
},
"definitions": {
"rewardRelationships": {
"type": "object",
"required": [
"receivingAccount",
"fundingAccount",
"customer"
],
"properties": {
"card": {
"type": "object",
"title": "cardRelationship",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "card"
}
}
}
}
},
"customer": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
},
"transaction": {
"type": "object",
"title": "transactionRelationship",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "transaction"
}
}
}
}
},
"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": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
}
}
}
}
}
}
}
CreateWebhookViaApiRequest
{
"type": "object",
"title": "createWebhook",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"default": "webhook"
},
"attributes": {
"type": "object",
"required": [
"label",
"url",
"token",
"contentType",
"deliveryMode"
],
"properties": {
"url": {
"type": "string"
},
"label": {
"type": "string"
},
"token": {
"type": "string"
},
"contentType": {
"enum": [
"Json",
"JsonAPI"
],
"type": "string"
},
"deliveryMode": {
"type": "string"
},
"includeResources": {
"type": "boolean"
},
"subscriptionType": {
"enum": [
"All",
"OnlyAuthorizationRequest"
],
"type": "string"
}
}
}
}
}
}
}
CreateWebhookViaApiResponse
{
"type": "object",
"title": "UnitWebhookResponse",
"properties": {
"data": {
"type": "object",
"title": "Webhook",
"required": [
"type",
"id",
"attributes"
],
"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": "webhook"
},
"attributes": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"label": {
"type": "string"
},
"token": {
"type": "string"
},
"status": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"contentType": {
"enum": [
"Json",
"JsonAPI"
],
"type": "string"
},
"deliveryMode": {
"enum": [
"AtMostOnce",
"AtLeastOnce"
],
"type": "string"
},
"subscriptionType": {
"type": "string"
}
}
}
}
}
}
}
DeclineAuthorizationRequestViaApiRequest
{
"type": "object",
"title": "DeclineAuthorizationRequest",
"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"
}
}
}
DeclineAuthorizationRequestViaApiResponse
{
"type": "object",
"title": "UnitAuthorizationRequestResponse",
"properties": {
"data": {
"$ref": "#/paths/~1authorization-requests~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data"
}
}
}
DisableWebhookViaApiResponse
{
"type": "object",
"title": "UnitWebhookResponse",
"properties": {
"data": {
"$ref": "#/paths/~1webhooks/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
DownloadADocumentBackSideViaApiResponse
{
"type": "string",
"format": "binary"
}
DownloadADocumentViaApiResponse
{
"type": "string",
"format": "binary"
}
EnableWebhookViaApiResponse
{
"type": "object",
"title": "UnitWebhookResponse",
"properties": {
"data": {
"$ref": "#/paths/~1webhooks/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
FireEventByIdResponse
{
"type": "object",
"title": "UnitEventResponse",
"properties": {
"data": {
"$ref": "#/paths/~1events~1%7BeventId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data"
}
}
}
FreezeACardViaApiResponse
{
"type": "object",
"title": "UnitCardResponse",
"properties": {
"data": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
FreezeAnAccountByIdRequest
{
"type": "object",
"title": "FreezeAccountRequest",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"enum": [
"creditAccountFreeze",
"accountFreeze"
],
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"reason": {
"enum": [
"Fraud",
"Other"
],
"type": "string"
},
"reasonText": {
"type": "string",
"nullable": true
}
}
}
}
}
}
}
GetABackImageByApiResponse
{
"type": "string",
"format": "binary"
}
GetAFrontImageViaApiResponse
{
"type": "string",
"format": "binary"
}
GetAccountByIdResponse
{
"type": "object",
"title": "UnitAccountResponseWithIncluded",
"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"
}
}
}
}
GetAccountLimitsByIdResponse
{
"type": "object",
"title": "UnitGetAccountLimitsResponse",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"card": {
"type": "object",
"properties": {
"limits": {
"type": "object",
"properties": {
"dailyDeposit": {
"type": "number"
},
"dailyPurchase": {
"type": "number"
},
"dailyWithdrawal": {
"type": "number"
},
"dailyCardTransaction": {
"type": "number"
}
}
},
"totalsDaily": {
"type": "object",
"properties": {
"deposit": {
"type": "number"
},
"purchase": {
"type": "number"
},
"withdrawal": {
"type": "number"
},
"cardTransaction": {
"type": "number"
}
}
}
}
}
}
}
}
}
}
}
GetApplicationByIdResponse
{
"type": "object",
"title": "UnitApplicationResponseWithIncluded",
"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"
}
}
}
GetApplicationFormByIdResponse
{
"type": "object",
"title": "UnitApplicationFormResponseWithIncluded",
"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"
}
}
}
GetAtmLocationsListFromApiResponse
{
"type": "array",
"items": {
"type": "object",
"title": "AtmLocation",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"default": "atmLocation"
},
"attributes": {
"type": "object",
"properties": {
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"network": {
"type": "string"
},
"distance": {
"type": "integer"
},
"coordinates": {
"type": "object",
"required": [
"longitude",
"latitude"
],
"properties": {
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
}
}
},
"locationName": {
"type": "string"
},
"surchargeFree": {
"type": "boolean"
},
"acceptDeposits": {
"type": "boolean"
}
}
}
}
},
"title": "UnitAtmLocationsListResponse"
}
GetAuthorizationByIdResponse
{
"type": "object",
"title": "UnitAuthorizationResponse",
"properties": {
"data": {
"type": "object",
"title": "Authorization Document",
"required": [
"type",
"id",
"relationships"
],
"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": "authorization"
},
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"cardLast4Digits",
"merchant",
"recurring",
"status"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"status": {
"type": "string"
},
"summary": {
"type": "string"
},
"merchant": {
"type": "object",
"title": "Merchant",
"required": [
"name",
"type",
"category"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "integer"
},
"category": {
"type": "string"
},
"location": {
"type": "string"
}
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"recurring": {
"type": "boolean"
},
"cardNetwork": {
"type": "string"
},
"declineReason": {
"type": "string"
},
"digitalWallet": {
"type": "string"
},
"paymentMethod": {
"type": "string"
},
"cardLast4Digits": {
"type": "string"
},
"cardVerificationData": {
"type": "object",
"title": "Card Verification Data",
"required": [
"verificationMethod"
],
"properties": {
"verificationMethod": {
"type": "string"
}
}
},
"cashWithdrawalAmount": {
"type": "integer"
}
}
},
"relationships": {
"$ref": "#/paths/~1authorizations~1%7BauthorizationId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/authorizationRelationships"
}
},
"definitions": {
"authorizationRelationships": {
"type": "object",
"title": "authorizationRelationships"
}
}
}
}
}
GetAuthorizationRequestByIdResponse
{
"type": "object",
"title": "UnitAuthorizationRequestsResponse",
"properties": {
"data": {
"type": "object",
"title": "AuthorizationRequest Document",
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string"
}
},
"definitions": {
"AtmAuthorizationRequest": {
"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",
"required": [
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"status",
"partialApprovalAllowed",
"direction",
"atmName",
"surcharge"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"status": {
"type": "string"
},
"atmName": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"type": "string"
},
"surcharge": {
"type": "integer"
},
"atmLocation": {
"type": "string"
},
"cardNetwork": {
"type": "string"
},
"declineReason": {
"type": "string"
},
"approvedAmount": {
"type": "integer"
},
"partialApprovalAllowed": {
"type": "boolean"
},
"internationalServiceFee": {
"type": "number",
"nullable": true
}
}
},
"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"
}
}
}
],
"title": "AtmAuthorizationRequest Resource"
},
"approveAuthorizationRequest": {
"type": "object",
"title": "Approve Authorization Request",
"required": [
"type",
"attributes"
],
"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"
}
}
}
}
},
"declineAuthorizationRequest": {
"type": "object",
"title": "Decline Authorization Request",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"default": "declineAuthorizationRequest"
},
"attributes": {
"type": "object",
"properties": {
"reason": {
"enum": [
"AccountClosed",
"CardExceedsAmountLimit",
"DoNotHonor",
"InsufficientFunds",
"InvalidMerchant",
"ReferToCardIssuer",
"RestrictedCard",
"TransactionNotPermittedToCardholder"
],
"type": "string"
}
}
}
}
},
"PurchaseAuthorizationRequest": {
"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",
"required": [
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"status",
"partialApprovalAllowed",
"merchant",
"recurring"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"status": {
"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"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"ecommerce": {
"type": "boolean"
},
"recurring": {
"type": "boolean"
},
"cardNetwork": {
"type": "string"
},
"cardPresent": {
"type": "boolean"
},
"declineReason": {
"type": "string"
},
"digitalWallet": {
"type": "string"
},
"paymentMethod": {
"type": "string"
},
"approvedAmount": {
"type": "integer"
},
"healthcareAmounts": {
"type": "object",
"title": "Healthcare Amounts",
"required": [
"transitAmount",
"prescriptionRXAmount",
"visionOpticalAmount",
"clinicOtherQualifiedMedicalAmount",
"dentalAmount",
"totalHealthcareAmount"
],
"properties": {
"dentalAmount": {
"type": "integer"
},
"transitAmount": {
"type": "integer"
},
"visionOpticalAmount": {
"type": "integer"
},
"prescriptionRXAmount": {
"type": "integer"
},
"totalHealthcareAmount": {
"type": "integer"
},
"clinicOtherQualifiedMedicalAmount": {
"type": "integer"
}
}
},
"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"
},
"cashWithdrawalAmount": {
"type": "integer"
},
"partialApprovalAllowed": {
"type": "boolean"
}
}
},
"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"
}
}
}
],
"title": "PurchaseAuthorizationRequest Resource"
},
"authorizationRequestRelationships": {
"type": "object",
"title": "authorizationRequestRelationships",
"required": [
"customer",
"account",
"card"
],
"properties": {
"card": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "card"
}
}
}
}
},
"account": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "account"
}
}
}
}
},
"customer": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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"
}
}
}
}
},
"fundingAccount": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "account"
}
}
}
}
}
}
},
"CardTransactionAuthorizationRequest": {
"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",
"required": [
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"status",
"partialApprovalAllowed",
"merchant",
"recurring"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"status": {
"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"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"recurring": {
"type": "boolean"
},
"cardNetwork": {
"type": "string"
},
"declineReason": {
"type": "string"
},
"digitalWallet": {
"type": "string"
},
"paymentMethod": {
"type": "string"
},
"approvedAmount": {
"type": "integer"
},
"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"
},
"partialApprovalAllowed": {
"type": "boolean"
}
}
},
"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"
}
}
}
],
"title": "CardTransactionAuthorizationRequest Resource"
}
},
"discriminator": {
"mapping": {
"atmAuthorizationRequest": "#/definitions/AtmAuthorizationRequest",
"purchaseAuthorizationRequest": "#/definitions/PurchaseAuthorizationRequest",
"cardTransactionAuthorizationRequest": "#/definitions/CardTransactionAuthorizationRequest"
},
"propertyName": "type"
}
}
}
}
GetBankVerificationPdfFromApiResponse
{
"type": "string",
"format": "binary"
}
GetCardByIdResponse
{
"type": "object",
"title": "UnitCardResponse",
"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"
}
}
}
}
GetCardLimitsByIdResponse
{
"type": "object",
"title": "UnitCardResponse",
"properties": {
"data": {
"type": "object",
"title": "Account Limits Resource",
"properties": {
"type": {
"type": "string"
}
},
"definitions": {
"CreditLimits": {
"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",
"required": [
"attributes"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"card"
],
"properties": {
"card": {
"type": "object",
"required": [
"limits",
"totalsDaily"
],
"properties": {
"limits": {
"type": "object",
"required": [
"dailyWithdrawal",
"dailyDeposit",
"dailyPurchase",
"dailyCardTransaction"
],
"properties": {
"dailyDeposit": {
"type": "number"
},
"dailyPurchase": {
"type": "number"
},
"dailyWithdrawal": {
"type": "number"
},
"dailyCardTransaction": {
"type": "number"
}
}
},
"totalsDaily": {
"type": "object",
"required": [
"withdrawals",
"deposits",
"purchases",
"cardTransactions"
],
"properties": {
"deposits": {
"type": "number"
},
"purchases": {
"type": "number"
},
"withdrawals": {
"type": "number"
},
"cardTransactions": {
"type": "number"
}
}
}
}
}
}
}
}
}
],
"title": "Credit Account Limits"
},
"DepositLimits": {
"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",
"required": [
"attributes"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"ach",
"card",
"checkDeposit"
],
"properties": {
"ach": {
"type": "object",
"required": [
"limits",
"totalsDaily",
"totalsMonthly"
],
"properties": {
"limits": {
"type": "object",
"required": [
"dailyDebit",
"dailyCredit",
"monthlyDebit",
"monthlyCredit"
],
"properties": {
"dailyDebit": {
"type": "number"
},
"dailyCredit": {
"type": "number"
},
"monthlyDebit": {
"type": "number"
},
"monthlyCredit": {
"type": "number"
},
"dailyDebitSoft": {
"type": "number"
},
"monthlyDebitSoft": {
"type": "number"
}
}
},
"totalsDaily": {
"type": "object",
"required": [
"debits",
"credits"
],
"properties": {
"debits": {
"type": "number"
},
"credits": {
"type": "number"
}
}
},
"totalsMonthly": {
"type": "object",
"required": [
"debits",
"credits"
],
"properties": {
"debits": {
"type": "number"
},
"credits": {
"type": "number"
}
}
}
}
},
"card": {
"type": "object",
"required": [
"limits",
"totalsDaily"
],
"properties": {
"limits": {
"type": "object",
"required": [
"dailyWithdrawal",
"dailyDeposit",
"dailyPurchase",
"dailyCardTransaction"
],
"properties": {
"dailyDeposit": {
"type": "number"
},
"dailyPurchase": {
"type": "number"
},
"dailyWithdrawal": {
"type": "number"
},
"dailyCardTransaction": {
"type": "number"
}
}
},
"totalsDaily": {
"type": "object",
"required": [
"withdrawals",
"deposits",
"purchases",
"cardTransactions"
],
"properties": {
"deposits": {
"type": "number"
},
"purchases": {
"type": "number"
},
"withdrawals": {
"type": "number"
},
"cardTransactions": {
"type": "number"
}
}
}
}
},
"checkDeposit": {
"type": "object",
"required": [
"limits",
"totalsDaily",
"totalsMonthly"
],
"properties": {
"limits": {
"type": "object",
"required": [
"daily",
"monthly",
"dailySoft",
"monthlySoft"
],
"properties": {
"daily": {
"type": "number"
},
"monthly": {
"type": "number"
},
"dailySoft": {
"type": "number"
},
"monthlySoft": {
"type": "number"
}
}
},
"totalsDaily": {
"type": "number"
},
"totalsMonthly": {
"type": "number"
}
}
}
}
}
}
}
],
"title": "Deposit Account Limits"
}
},
"discriminator": {
"mapping": {
"limits": "#/definitions/DepositLimits",
"creditLimits": "#/definitions/CreditLimits"
},
"propertyName": "type"
}
}
}
}
GetCardPinStatusPinStatusResponse
{
"type": "object",
"title": "UnitCardResponse",
"properties": {
"data": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/pinStatus"
}
}
}
GetCheckDepositBackImageByIdResponse
{
"type": "object",
"title": "UnitCheckDepositResponse",
"properties": {
"data": {
"type": "string"
}
}
}
GetCheckDepositByIdResponse
{
"type": "object",
"title": "UnitCheckDepositResponse",
"properties": {
"data": {
"$ref": "#/paths/~1check-deposits/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
GetCheckDepositFrontImageByIdResponse
{
"type": "object",
"title": "UnitCheckDepositResponse",
"properties": {
"data": {
"type": "string"
}
}
}
GetCounterpartyBalanceRecurringPaymentFromApiResponse
{
"type": "object",
"title": "UnitCounterpartyResponse",
"properties": {
"data": {
"type": "object",
"title": "Counterparty Balance",
"required": [
"type",
"id",
"relationships"
],
"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": "counterpartyBalance"
},
"attributes": {
"type": "object",
"required": [
"balance"
],
"properties": {
"balance": {
"type": "number"
},
"available": {
"type": "number"
}
}
},
"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"
}
},
"definitions": {
"counterpartyBalanceRelationships": {
"type": "object",
"title": "counterpartyBalanceRelationships",
"required": [
"customer",
"counterparty"
],
"properties": {
"customer": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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"
}
}
}
}
},
"counterparty": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "counterparty"
}
}
}
}
}
}
}
}
}
}
}
GetCounterpartyByIdResponse
{
"type": "object",
"title": "UnitCounterpartyResponse",
"properties": {
"data": {
"$ref": "#/paths/~1counterparties/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
GetDisputeByIdResponse
{
"type": "object",
"title": "UnitDisputeResponse",
"properties": {
"data": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items"
}
}
}
GetEventByIdResponse
{
"type": "object",
"title": "UnitEventResponse",
"properties": {
"data": {
"type": "object",
"title": "Event Resource",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {}
},
"relationships": {
"type": "object",
"title": "eventRelationships",
"properties": {}
}
}
}
}
}
GetInstitutionByRoutingNumberResponse
{
"type": "object",
"title": "UnitInstitutionResponse",
"properties": {
"data": {
"type": "object",
"title": "Institution Resource",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"default": "institution"
},
"attributes": {
"type": "object",
"required": [
"routingNumber",
"name",
"isWireSupported",
"isACHSupported"
],
"properties": {
"name": {
"type": "string"
},
"address": {
"type": "string"
},
"routingNumber": {
"type": "string"
},
"isACHSupported": {
"type": "boolean"
},
"isWireSupported": {
"type": "boolean"
}
}
}
}
}
}
}
GetListAccountEndofdayBalancesHistoryFromApiResponse
{
"type": "object",
"title": "UnitGetAccountEndOfDayListResponse",
"properties": {
"data": {
"type": "object",
"title": "Account End Of Day Resource",
"required": [
"type",
"id",
"relationships",
"attributes"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"accountEndOfDay"
],
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"date",
"balance",
"hold",
"available"
],
"properties": {
"date": {
"type": "string",
"format": "date"
},
"hold": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"available": {
"type": "integer"
},
"overdraftLimit": {
"type": "integer"
}
}
},
"relationships": {
"$ref": "#/paths/~1account-end-of-day/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/relationships"
}
},
"definitions": {
"relationships": {
"type": "object",
"required": [
"account"
],
"properties": {
"account": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "account"
}
}
}
}
},
"customer": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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"
}
}
}
}
}
}
}
}
}
}
}
GetListAccountsFromApiResponse
{
"type": "object",
"title": "UnitAccountsListResponse",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"title": "Account Document",
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string"
}
},
"definitions": {
"glAccount": {
"type": "object",
"title": "General Ledger Account",
"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": "glAccount"
},
"attributes": {
"type": "object",
"required": [
"createdAt",
"name",
"balance",
"hold",
"available",
"category",
"currency"
],
"properties": {
"hold": {
"type": "integer"
},
"name": {
"type": "string"
},
"status": {
"enum": [
"Open",
"Closed"
],
"type": "string"
},
"balance": {
"type": "integer"
},
"category": {
"enum": [
"Asset",
"Liability"
],
"type": "string"
},
"currency": {
"type": "string",
"default": "USD"
},
"available": {
"type": "integer"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"closeReason": {
"enum": [
"ByCustomer",
"Fraud"
],
"type": "string"
},
"fraudReason": {
"enum": [
"ACHActivity",
"CardActivity",
"CheckActivity",
"ApplicationHistory",
"AccountActivity",
"ClientIdentified",
"IdentityTheft",
"LinkedToFraudulentCustomer"
],
"type": "string"
}
}
}
}
},
"batchAccount": {
"type": "object",
"title": "Batch Account",
"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": "batchAccount"
},
"attributes": {
"type": "object",
"required": [
"createdAt",
"name",
"depositProduct",
"currency",
"routingNumber",
"balance",
"hold",
"available"
],
"properties": {
"hold": {
"type": "integer"
},
"name": {
"type": "string"
},
"status": {
"enum": [
"Open",
"Closed"
],
"type": "string"
},
"balance": {
"type": "integer"
},
"currency": {
"type": "string",
"default": "USD"
},
"available": {
"type": "integer"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"closeReason": {
"enum": [
"ByCustomer",
"Fraud"
],
"type": "string"
},
"fraudReason": {
"enum": [
"ACHActivity",
"CardActivity",
"CheckActivity",
"ApplicationHistory",
"AccountActivity",
"ClientIdentified",
"IdentityTheft",
"LinkedToFraudulentCustomer"
],
"type": "string"
},
"accountNumber": {
"type": "string",
"pattern": "^\\d{10,12}$"
},
"routingNumber": {
"type": "string",
"pattern": "^\\d{9}$"
},
"depositProduct": {
"type": "string"
},
"maskedAccountNumber": {
"type": "string",
"pattern": "^\\*{6,8}\\d{4}$"
}
}
},
"relationships": {
"type": "object",
"required": [
"org"
],
"properties": {
"org": {
"$ref": "#/paths/~1customers~1%7BcustomerId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/relationships/properties/org"
}
}
}
}
},
"CreditAccount": {
"type": "object",
"allOf": [
{
"$ref": "#/paths/~1accounts/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items"
},
{
"type": "object",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"name",
"creditTerms",
"currency",
"balance",
"hold",
"available",
"tags",
"status",
"creditLimit"
],
"properties": {
"hold": {
"type": "integer"
},
"name": {
"type": "string"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"status": {
"enum": [
"Open",
"Closed",
"Frozen"
],
"type": "string"
},
"balance": {
"type": "integer"
},
"currency": {
"type": "string",
"default": "USD"
},
"available": {
"type": "integer"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"closeReason": {
"enum": [
"ByCustomer",
"Fraud",
"Overdue"
],
"type": "string"
},
"creditLimit": {
"type": "integer",
"minimum": 0
},
"creditTerms": {
"type": "string"
},
"fraudReason": {
"enum": [
"ACHActivity",
"CardActivity",
"CheckActivity",
"ApplicationHistory",
"AccountActivity",
"ClientIdentified",
"IdentityTheft",
"LinkedToFraudulentCustomer"
],
"type": "string"
},
"freezeReason": {
"type": "string"
},
"closeReasonText": {
"type": "string",
"maxLength": 255
}
}
},
"relationships": {
"type": "object",
"title": "creditAccountRelationships",
"required": [
"customer"
],
"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
}
}
}
],
"title": "Credit Account"
},
"DepositAccount": {
"type": "object",
"allOf": [
{
"$ref": "#/paths/~1accounts/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items"
},
{
"type": "object",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"name",
"depositProduct",
"routingNumber",
"currency",
"balance",
"hold",
"available",
"tags",
"status"
],
"properties": {
"hold": {
"type": "integer"
},
"name": {
"type": "string"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"status": {
"enum": [
"Open",
"Closed",
"Frozen"
],
"type": "string"
},
"balance": {
"type": "integer"
},
"currency": {
"type": "string",
"default": "USD"
},
"available": {
"type": "integer"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"dacaStatus": {
"enum": [
"Activated",
"Entered"
],
"type": "string"
},
"closeReason": {
"enum": [
"ByCustomer",
"Fraud"
],
"type": "string"
},
"fraudReason": {
"enum": [
"ACHActivity",
"CardActivity",
"CheckActivity",
"ApplicationHistory",
"AccountActivity",
"ClientIdentified",
"IdentityTheft",
"LinkedToFraudulentCustomer"
],
"type": "string"
},
"freezeReason": {
"type": "string"
},
"accountNumber": {
"type": "string",
"pattern": "^\\d{10,12}$"
},
"routingNumber": {
"type": "string",
"pattern": "^\\d{9}$"
},
"depositProduct": {
"type": "string"
},
"overdraftLimit": {
"type": "integer",
"minimum": 0
},
"closeReasonText": {
"type": "string",
"maxLength": 255
},
"maskedAccountNumber": {
"type": "string",
"pattern": "^\\*{6,8}\\d{4}$"
},
"isOverdrawnWithinLimit": {
"type": "boolean"
},
"secondaryAccountNumber": {
"type": "object",
"required": [
"routingNumber",
"accountNumber"
],
"properties": {
"accountNumber": {
"type": "string",
"pattern": "^\\d{10,12}$"
},
"routingNumber": {
"type": "string",
"pattern": "^\\d{9}$"
}
}
}
}
},
"relationships": {
"type": "object",
"title": "depositAccountRelationships",
"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
}
}
}
],
"title": "Deposit Account"
},
"orgGeneralLedgerAccount": {
"type": "object",
"title": "Org General Ledger Account",
"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": "orgGeneralLedgerAccount"
},
"attributes": {
"type": "object",
"required": [
"createdAt",
"name",
"balance",
"hold",
"available",
"category",
"currency"
],
"properties": {
"hold": {
"type": "integer"
},
"name": {
"type": "string"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"orgId": {
"type": "string"
},
"status": {
"enum": [
"Open",
"Closed"
],
"type": "string"
},
"balance": {
"type": "integer"
},
"category": {
"enum": [
"Asset",
"Liability"
],
"type": "string"
},
"currency": {
"type": "string",
"default": "USD"
},
"available": {
"type": "integer"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
}
}
}
}
},
"discriminator": {
"mapping": {
"creditAccount": "#/definitions/CreditAccount",
"depositAccount": "#/definitions/DepositAccount"
},
"propertyName": "type"
}
}
},
"meta": {
"$ref": "#/paths/~1applications/get/responses/200/content/application~1vnd.api%2Bjson/schema/properties/meta"
},
"included": {
"type": "array",
"items": {
"$ref": "#/paths/~1customers/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items"
}
}
}
}
GetListApplicationFormsViaApiResponse
{
"type": "object",
"title": "UnitApplicationFormsListResponse",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/paths/~1application-forms/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
}
GetListApplicationsFromApi200Response
{
"type": "object",
"title": "UnitListApplicationsResponse",
"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"
},
"total": {
"type": "integer"
},
"offset": {
"type": "integer"
}
}
}
}
}
}
}
GetListApplicationsFromApiResponse
{
"type": "object",
"title": "UnitError"
}
GetListAuthorizationRequestsFromApiResponse
{
"type": "object",
"title": "UnitListAuthorizationRequestsResponse",
"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"
}
}
}
}
GetListAuthorizationsFromApiResponse
{
"type": "object",
"title": "UnitListAuthorizationsResponse",
"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"
}
}
}
}
GetListCheckDepositsFromApiResponse
{
"type": "object",
"title": "UnitListCheckDepositsResponse",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/paths/~1check-deposits/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
}
GetListCheckPaymentsFromApiResponse
{
"type": "object",
"title": "UnitListCheckPaymentsResponse",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"title": "Check Payment Resource",
"required": [
"type",
"id",
"attributes",
"relationships"
],
"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"
},
"attributes": {
"type": "object",
"required": [
"createdAt",
"updatedAt",
"amount",
"status",
"originated"
],
"properties": {
"memo": {
"type": "string"
},
"onUs": {
"type": "string"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"sendAt": {
"type": "string",
"format": "date-time"
},
"status": {
"enum": [
"MarkedForReturn",
"Returned",
"Processed",
"PendingReview"
],
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"trackedAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"originated": {
"type": "boolean"
},
"postalCode": {
"type": "string"
},
"checkNumber": {
"type": "string"
},
"description": {
"type": "string"
},
"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"
}
}
},
"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"
},
"onUsAuxiliary": {
"type": "string"
},
"deliveryStatus": {
"enum": [
"Mailed",
"InLocalArea",
"Delivered",
"Rerouted",
"ReturnedToSender"
],
"type": "string"
},
"expirationDate": {
"type": "string",
"format": "date"
},
"expectedDelivery": {
"type": "string",
"format": "date"
},
"returnCutoffTime": {
"type": "string",
"format": "date-time"
},
"pendingReviewReasons": {
"type": "array",
"items": {
"enum": [
"NameMissMatch",
"SoftLimit"
],
"type": "string"
}
},
"counterpartyRoutingNumber": {
"type": "string"
},
"additionalVerificationStatus": {
"enum": [
"Required",
"NotRequired",
"Approved"
],
"type": "string"
}
}
},
"relationships": {
"type": "object",
"required": [
"account"
],
"properties": {
"account": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"depositAccount",
"account"
],
"type": "string"
}
}
}
}
},
"customer": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"businessCustomer",
"individualCustomer",
"customer"
],
"type": "string"
}
}
}
}
},
"customers": {
"$ref": "#/paths/~1accounts/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateDepositAccount/properties/relationships/properties/customers"
},
"transaction": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "transaction"
}
}
}
}
}
}
}
}
}
}
}
}
GetListCounterpartiesFromApiResponse
{
"type": "object",
"title": "UnitCounterpartiesListResponse",
"properties": {
"data": {
"$ref": "#/paths/~1counterparties/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
GetListCustomersApiListResponse
{
"type": "object",
"title": "UnitCustomersListResponse",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"title": "Customer",
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string"
}
},
"definitions": {
"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",
"required": [
"name",
"stateOfIncorporation",
"contact",
"status"
],
"properties": {
"name": {
"type": "string"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"taxId": {
"type": "string"
},
"status": {
"enum": [
"Active",
"Archived"
],
"type": "string"
},
"contact": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateTrustApplication/properties/attributes/properties/contact"
},
"riskRate": {
"enum": [
"low",
"medium",
"high"
],
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"revocability": {
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/TrustApplication/allOf/1/properties/attributes/properties/revocability"
},
"archiveReason": {
"enum": [
"Inactive",
"FraudACHActivity",
"FraudCardActivity",
"FraudCheckActivity",
"FraudApplicationHistory",
"FraudAccountActivity",
"FraudClientIdentified",
"FraudLinkedToFraudulentCustomer"
],
"type": "string"
},
"sourceOfFunds": {
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/TrustApplication/allOf/1/properties/attributes/properties/sourceOfFunds"
},
"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"
}
},
"stateOfIncorporation": {
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1customers/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items/definitions/customerRelationships"
}
}
}
],
"title": "TrustCustomer"
},
"customerLinkage": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"customer",
"businessCustomer",
"individualCustomer"
],
"type": "string"
}
}
}
}
},
"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",
"required": [
"name",
"entityType",
"stateOfIncorporation",
"contact",
"status"
],
"properties": {
"dba": {
"type": "string"
},
"ein": {
"type": "string",
"pattern": "^\\d{9}$"
},
"name": {
"type": "string"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"status": {
"enum": [
"Active",
"Archived"
],
"type": "string"
},
"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"
},
"purpose": {
"type": "string"
},
"riskRate": {
"enum": [
"low",
"medium",
"high"
],
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"entityType": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/entityType"
},
"archiveReason": {
"enum": [
"Inactive",
"FraudACHActivity",
"FraudCardActivity",
"FraudCheckActivity",
"FraudApplicationHistory",
"FraudAccountActivity",
"FraudClientIdentified",
"FraudLinkedToFraudulentCustomer"
],
"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"
}
},
"dateOfIncorporation": {
"type": "string",
"format": "date"
},
"stateOfIncorporation": {
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1customers/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items/definitions/customerRelationships"
}
}
}
],
"title": "BusinessCustomer"
},
"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",
"required": [
"createdAt",
"fullName",
"status"
],
"properties": {
"dba": {
"type": "string"
},
"ein": {
"type": "string"
},
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"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"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"status": {
"enum": [
"Active",
"Archived"
],
"type": "string"
},
"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"
},
"passport": {
"type": "string"
},
"riskRate": {
"enum": [
"low",
"medium",
"high"
],
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"maskedSSN": {
"type": "string",
"pattern": "^\\*{5}\\d{4}$"
},
"jwtSubject": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent/properties/jwtSubject"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"archiveReason": {
"enum": [
"Inactive",
"FraudACHActivity",
"FraudCardActivity",
"FraudCheckActivity",
"FraudApplicationHistory",
"FraudAccountActivity",
"FraudClientIdentified",
"FraudLinkedToFraudulentCustomer"
],
"type": "string"
},
"maskedPassport": {
"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"
}
},
"matriculaConsular": {
"type": "string"
},
"soleProprietorship": {
"type": "boolean",
"default": "false"
},
"maskedMatriculaConsular": {
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1customers/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items/definitions/customerRelationships"
}
}
}
],
"title": "IndividualCustomer"
},
"customerRelationships": {
"type": "object",
"title": "customerRelationships",
"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
}
},
"discriminator": {
"mapping": {
"trustCustomer": "#/definitions/TrustCustomer",
"businessCustomer": "#/definitions/BusinessCustomer",
"individualCustomer": "#/definitions/IndividualCustomer"
},
"propertyName": "type"
}
}
},
"meta": {
"$ref": "#/paths/~1applications/get/responses/200/content/application~1vnd.api%2Bjson/schema/properties/meta"
}
}
}
GetListDisputesFromApiResponse
{
"type": "array",
"items": {
"type": "object",
"title": "Dispute Document",
"required": [
"type",
"id",
"relationships"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[1-9]\\d*$"
},
"type": {
"type": "string",
"default": "dispute"
},
"attributes": {
"type": "object",
"required": [
"externalId",
"source",
"description",
"status",
"createdAt",
"amount"
],
"properties": {
"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"
},
"source": {
"enum": [
"DebitCard",
"ACH"
],
"type": "string"
},
"status": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"externalId": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 1024
},
"statusHistory": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
}
}
},
"decisionReason": {
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/definitions/disputeRelationships"
}
},
"definitions": {
"disputeRelationships": {
"type": "object",
"title": "disputeRelationships",
"required": [
"customer",
"account",
"transaction"
],
"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"
},
"transaction": {
"$ref": "#/paths/~1check-deposits/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createCheckDepositRelationships/properties/account"
}
}
}
}
},
"title": "UnitDisputesListResponse"
}
GetListEventsFromApiResponse
{
"type": "object",
"title": "UnitEventListResponse",
"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"
}
}
}
}
GetListOfCardsFromApiResponse
{
"type": "object",
"title": "UnitCardResponseCardsList",
"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"
}
}
}
}
GetListOfDocumentsViaApiResponse
{
"type": "object",
"title": "UnitListDocumentsResponse",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/paths/~1applications/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/included/items"
}
}
}
}
GetListOrgApiTokensFromApiResponse
{
"type": "object",
"title": "UnitOrgApiTokensListResponse",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/paths/~1users~1%7BuserId%7D~1api-tokens/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
}
GetListPaymentsFromApiResponse
{
"type": "object",
"title": "UnitPaymentsListResponse",
"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"
}
},
"meta": {
"$ref": "#/paths/~1applications/get/responses/200/content/application~1vnd.api%2Bjson/schema/properties/meta"
},
"included": {
"$ref": "#/paths/~1transactions/get/responses/200/content/application~1vnd.api%2Bjson/schema/properties/included"
}
}
}
GetListRecurringPaymentsFromApiResponse
{
"type": "object",
"title": "UnitRecurringPaymentListResponse",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"title": "Recurring Payment Resource",
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string"
}
},
"definitions": {
"schedule": {
"type": "object",
"title": "Schedule",
"required": [
"interval",
"nextScheduledAction"
],
"properties": {
"endTime": {
"type": "string",
"format": "date"
},
"interval": {
"enum": [
"Monthly"
],
"type": "string"
},
"startTime": {
"type": "string",
"format": "date"
},
"dayOfMonth": {
"type": "integer",
"maximum": 28,
"minimum": -5
},
"nextScheduledAction": {
"type": "string",
"format": "date"
},
"totalNumberOfPayments": {
"type": "integer",
"minimum": 1
}
}
},
"RecurringDebitAchPayment": {
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"status",
"description",
"amount",
"schedule",
"numberOfPayments"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"status": {
"enum": [
"Pending",
"Active",
"Completed",
"Disabled"
],
"type": "string"
},
"addenda": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"sameDay": {
"type": "boolean",
"default": false
},
"schedule": {
"$ref": "#/paths/~1recurring-payments/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items/definitions/schedule"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string",
"maxLength": 10,
"minLength": 1
},
"numberOfPayments": {
"type": "integer"
},
"verifyCounterpartyBalance": {
"type": "boolean",
"default": false
}
}
},
"relationships": {
"$ref": "#/paths/~1recurring-payments/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items/definitions/recurringAchPaymentRelationships"
}
}
}
],
"title": "Recurring Debit ACH Payment"
},
"RecurringCreditAchPayment": {
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"status",
"description",
"amount",
"schedule",
"numberOfPayments"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"status": {
"enum": [
"Pending",
"Active",
"Completed",
"Disabled"
],
"type": "string"
},
"addenda": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"schedule": {
"$ref": "#/paths/~1recurring-payments/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items/definitions/schedule"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string",
"maxLength": 10,
"minLength": 1
},
"numberOfPayments": {
"type": "integer"
}
}
},
"relationships": {
"$ref": "#/paths/~1recurring-payments/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items/definitions/recurringAchPaymentRelationships"
}
}
}
],
"title": "Recurring Credit ACH Payment"
},
"RecurringCreditBookPayment": {
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"updatedAt",
"amount",
"description",
"status",
"schedule",
"numberOfPayments"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"status": {
"enum": [
"Pending",
"Active",
"Completed",
"Disabled"
],
"type": "string"
},
"schedule": {
"$ref": "#/paths/~1recurring-payments/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items/definitions/schedule"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"numberOfPayments": {
"type": "integer"
}
}
},
"relationships": {
"$ref": "#/paths/~1recurring-payments/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items/definitions/recurringBookPaymentRelationships"
}
}
}
],
"title": "Recurring Credit Book Payment"
},
"recurringAchPaymentRelationships": {
"type": "object",
"properties": {
"org": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string"
}
}
}
}
},
"account": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"depositAccount",
"account"
],
"type": "string"
}
}
}
}
},
"customer": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"businessCustomer",
"individualCustomer",
"customer"
],
"type": "string"
}
}
}
}
},
"counterparty": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"account",
"counterparty"
],
"type": "string"
}
}
}
}
}
}
},
"recurringBookPaymentRelationships": {
"type": "object",
"properties": {
"org": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string"
}
}
}
}
},
"account": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"depositAccount",
"account"
],
"type": "string"
}
}
}
}
},
"customer": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"businessCustomer",
"individualCustomer",
"customer"
],
"type": "string"
}
}
}
}
},
"counterpartyAccount": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"account"
],
"type": "string"
}
}
}
}
}
}
}
},
"discriminator": {
"mapping": {
"recurringDebitAchPayment": "#/definitions/RecurringDebitAchPayment",
"recurringCreditAchPayment": "#/definitions/RecurringCreditAchPayment",
"recurringCreditBookPayment": "#/definitions/RecurringCreditBookPayment"
},
"propertyName": "type"
}
}
},
"meta": {
"$ref": "#/paths/~1applications/get/responses/200/content/application~1vnd.api%2Bjson/schema/properties/meta"
}
}
}
GetListRepaymentsFromApiResponse
{
"type": "object",
"title": "UnitRepaymentsListResponse",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"title": "Repayment Resource",
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string"
}
},
"definitions": {
"AchRepayment": {
"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",
"required": [
"createdAt",
"status",
"amount"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"status": {
"enum": [
"Pending",
"PendingReview",
"Sent",
"Returned",
"Rejected",
"Clearing"
],
"type": "string"
},
"sameDay": {
"type": "boolean"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
}
},
"relationships": {
"type": "object",
"properties": {
"account": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"depositAccount",
"account"
],
"type": "string"
}
}
}
}
},
"payment": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "payment"
}
}
}
}
},
"customer": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"businessCustomer",
"individualCustomer",
"customer"
],
"type": "string"
}
}
}
}
},
"counterparty": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "counterparty"
}
}
}
}
},
"creditAccount": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "creditAccount"
}
}
}
}
}
}
}
}
}
],
"title": "ACH Repayment"
},
"BookRepayment": {
"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",
"required": [
"createdAt",
"status",
"amount"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"status": {
"enum": [
"Pending",
"PendingReview",
"Sent",
"Returned",
"Rejected"
],
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
}
},
"relationships": {
"type": "object",
"properties": {
"account": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"depositAccount",
"account"
],
"type": "string"
}
}
}
}
},
"payment": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "payment"
}
}
}
}
},
"customer": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"businessCustomer",
"individualCustomer",
"customer"
],
"type": "string"
}
}
}
}
},
"creditAccount": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "creditAccount"
}
}
}
}
},
"counterpartyAccount": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "account"
}
}
}
}
}
}
}
}
}
],
"title": "Book Repayment"
}
},
"discriminator": {
"mapping": {
"achRepayment": "#/definitions/AchRepayment",
"bookRepayment": "#/definitions/BookRepayment"
},
"propertyName": "type"
}
}
},
"meta": {
"$ref": "#/paths/~1applications/get/responses/200/content/application~1vnd.api%2Bjson/schema/properties/meta"
}
}
}
GetListRewardsFromApiResponse
{
"type": "object",
"title": "UnitRewardsListResponse",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/paths/~1rewards/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
}
GetListStatementsFromApiResponse
{
"type": "object",
"title": "UnitStatementsResponse",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"title": "Statement",
"required": [
"type",
"id",
"relationships",
"attributes"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string"
},
"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"
}
},
"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"
}
}
}
}
}
}
}
}
GetListTransactionsFromApiResponse
{
"type": "object",
"title": "UnitTransactionsListResponse",
"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"
}
},
"meta": {
"$ref": "#/paths/~1applications/get/responses/200/content/application~1vnd.api%2Bjson/schema/properties/meta"
},
"included": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object"
},
"relationships": {
"type": "object"
}
}
}
}
}
}
GetListWebhooksFromApiResponse
{
"type": "object",
"title": "UnitWebhooksListResponse",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/paths/~1webhooks/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
}
GetPaymentByIdResponse
{
"type": "object",
"title": "UnitPaymentResponseWithIncluded",
"properties": {
"data": {
"type": "object",
"title": "Payment Resource",
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string"
}
},
"definitions": {
"astra": {
"type": "object",
"title": "AstraPushToCardConfiguration",
"required": [
"debitFeePercent",
"institutionId",
"destinationCardId",
"routingNumber",
"accountNumber",
"referenceId"
],
"properties": {
"authToken": {
"type": "string",
"minLength": 1
},
"accountName": {
"type": "string",
"minLength": 1
},
"referenceId": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"accountNumber": {
"type": "string",
"minLength": 1
},
"institutionId": {
"type": "string",
"minLength": 1
},
"routingNumber": {
"type": "string",
"minLength": 1
},
"debitFeePercent": {
"type": "number"
},
"destinationCardId": {
"type": "string",
"minLength": 1
}
}
},
"AchPayment": {
"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",
"required": [
"type",
"id",
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"status",
"description",
"amount",
"direction"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"reason": {
"type": "string"
},
"status": {
"enum": [
"Pending",
"Rejected",
"Clearing",
"Sent",
"Canceled",
"Returned"
],
"type": "string"
},
"addenda": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"sameDay": {
"type": "boolean"
},
"secCode": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
},
"description": {
"type": "string",
"maxLength": 50,
"minLength": 1
},
"traceNumber": {
"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"
},
"settlementDate": {
"type": "string",
"format": "date"
},
"clearingDaysOverride": {
"type": "integer"
},
"expectedCompletionDate": {
"type": "string",
"format": "date"
},
"counterpartyVerificationMethod": {
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/paymentRelationships"
}
}
}
],
"title": "ACH Payment"
},
"BillPayment": {
"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",
"required": [
"type",
"id",
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"description",
"status"
],
"properties": {
"amount": {
"type": "integer",
"minimum": 1
},
"reason": {
"type": "string"
},
"status": {
"enum": [
"Initialized",
"Pending",
"Rejected",
"Clearing",
"Sent",
"Canceled",
"Returned"
],
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
},
"description": {
"type": "string",
"maxLength": 50,
"minLength": 1
}
}
},
"relationships": {
"$ref": "#/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/paymentRelationships"
}
}
}
],
"title": "Bill Payment"
},
"BookPayment": {
"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",
"required": [
"type",
"id",
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"description",
"status"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"reason": {
"type": "string"
},
"status": {
"enum": [
"Pending",
"Rejected",
"Clearing",
"Sent",
"Canceled",
"Returned"
],
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
},
"description": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"transactionSummaryOverride": {
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/paymentRelationships"
}
}
}
],
"title": "Book Payment"
},
"WirePayment": {
"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",
"required": [
"type",
"id",
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"description",
"status"
],
"properties": {
"amount": {
"type": "integer",
"minimum": 1
},
"reason": {
"type": "string"
},
"status": {
"enum": [
"Pending",
"Rejected",
"Clearing",
"Sent",
"Canceled",
"Returned"
],
"type": "string"
},
"imadOmad": {
"type": "object",
"properties": {
"imad": {
"type": "string"
},
"omad": {
"type": "string"
}
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit"
],
"type": "string"
},
"description": {
"type": "string",
"maxLength": 50,
"minLength": 1
},
"counterparty": {
"$ref": "#/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/wireCounterparty"
},
"settlementDate": {
"type": "string",
"format": "date"
}
}
},
"relationships": {
"$ref": "#/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/paymentRelationships"
}
}
}
],
"title": "Wire Payment"
},
"counterparty": {
"type": "object",
"title": "Counterparty",
"required": [
"routingNumber",
"accountNumber",
"accountType",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 50,
"minLength": 1
},
"accountType": {
"enum": [
"Checking",
"Savings",
"Loan"
],
"type": "string"
},
"accountNumber": {
"type": "string",
"pattern": "^\\d{1,17}$"
},
"routingNumber": {
"type": "string",
"pattern": "^\\d{9}$"
}
}
},
"wireCounterparty": {
"type": "object",
"title": "WireCounterparty",
"required": [
"routingNumber",
"accountNumber",
"address",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 50,
"minLength": 1
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"accountNumber": {
"type": "string",
"maxLength": 17
},
"routingNumber": {
"type": "string",
"pattern": "^\\d{9}$"
}
}
},
"pushToCardPayment": {
"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",
"required": [
"type",
"id",
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"description",
"status"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"reason": {
"type": "string"
},
"status": {
"enum": [
"Pending",
"Rejected",
"Sent"
],
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Debit",
"Credit"
],
"type": "string"
},
"description": {
"type": "string",
"minLength": 1
},
"astraRoutineId": {
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/paymentRelationships"
}
}
}
],
"title": "Push To Card Payment Response"
},
"additionalProperties": false,
"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"
}
}
}
}
}
},
"transaction": {
"$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"
},
"recurringPayment": {
"$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"
}
},
"additionalProperties": true
}
},
"discriminator": {
"mapping": {
"achPayment": "#/definitions/AchPayment",
"billPayment": "#/definitions/BillPayment",
"bookPayment": "#/definitions/BookPayment",
"wirePayment": "#/definitions/WirePayment"
},
"propertyName": "type"
}
},
"included": {
"$ref": "#/paths/~1transactions/get/responses/200/content/application~1vnd.api%2Bjson/schema/properties/included"
}
}
}
GetReceivedPaymentByIdResponse
{
"type": "object",
"title": "UnitReceivedPaymentResponseWithIncluded",
"properties": {
"data": {
"type": "object",
"title": "Received Payment Resource",
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"description",
"status",
"completionDate",
"companyName",
"counterpartyRoutingNumber",
"traceNumber",
"wasAdvanced",
"direction",
"secCode"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"status": {
"enum": [
"Pending",
"Advanced",
"Completed",
"Returned"
],
"type": "string"
},
"addenda": {
"type": "string"
},
"secCode": {
"type": "string",
"maxLength": 3,
"minLength": 3
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Debit",
"Credit"
],
"type": "string"
},
"companyName": {
"type": "string"
},
"description": {
"type": "string"
},
"traceNumber": {
"type": "string"
},
"wasAdvanced": {
"type": "boolean"
},
"isAdvaceable": {
"type": "boolean"
},
"returnReason": {
"type": "string"
},
"isAdvanceable": {
"type": "boolean"
},
"completionDate": {
"type": "string"
},
"receivingEntityName": {
"type": "string"
},
"counterpartyRoutingNumber": {
"type": "string"
}
}
},
"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"
}
},
"definitions": {
"receivedPaymentRelationships": {
"type": "object",
"required": [
"account",
"customer"
],
"properties": {
"account": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "account"
}
}
}
}
},
"customer": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"businessCustomer",
"individualCustomer",
"customer"
],
"type": "string"
}
}
}
}
},
"paymentAdvanceTransaction": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "transaction"
}
}
}
}
},
"receivePaymentTransaction": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "transaction"
}
}
}
}
},
"repayPaymentAdvanceTransaction": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "transaction"
}
}
}
}
}
},
"additionalProperties": true
}
}
},
"included": {
"$ref": "#/paths/~1transactions/get/responses/200/content/application~1vnd.api%2Bjson/schema/properties/included"
}
}
}
GetReceivedPaymentsListFromApiResponse
{
"type": "object",
"title": "UnitReceivedPaymentListResponse",
"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"
}
},
"meta": {
"$ref": "#/paths/~1applications/get/responses/200/content/application~1vnd.api%2Bjson/schema/properties/meta"
},
"included": {
"$ref": "#/paths/~1transactions/get/responses/200/content/application~1vnd.api%2Bjson/schema/properties/included"
}
}
}
GetRewardByIdResponse
{
"type": "object",
"title": "UnitRewardResponse",
"properties": {
"data": {
"$ref": "#/paths/~1rewards/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
GetStatementHtmlByIdResponse
{
"type": "string"
}
GetStatementPdfByIdResponse
{
"type": "string",
"format": "binary"
}
GetTransactionByIdResponse
{
"type": "object",
"title": "UnitTransactionResponse",
"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"
}
}
}
GetWebhookByIdResponse
{
"type": "object",
"title": "UnitWebhookResponse",
"properties": {
"data": {
"$ref": "#/paths/~1webhooks/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
ReportCardAsLostViaApiResponse
{
"type": "object",
"title": "UnitCardResponse",
"properties": {
"data": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
ReportCardAsStolenViaApiResponse
{
"type": "object",
"title": "UnitCardResponse",
"properties": {
"data": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
ReturnCheckPaymentByIdRequest
{
"type": "object",
"title": "ReturnCheckPaymentRequest",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"default": "checkPaymentReturn"
},
"attributes": {
"type": "object",
"properties": {
"reason": {
"enum": [
"InsufficientFunds",
"AccountClosed",
"AlteredCheck",
"ForgedSignature",
"PostdatedCheck",
"StopPaymentOrder",
"UnauthorizedDebit",
"WrongAmount",
"DuplicatePayment",
"MissingSignature",
"IrregularEndorsement",
"Other"
],
"type": "string"
}
}
}
}
}
}
}
RevokeOrgApiTokenRewardByIdResponse
{
"type": "object",
"title": "UnitApiTokenResponse",
"properties": {
"data": {
"$ref": "#/paths/~1users~1%7BuserId%7D~1api-tokens/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
StopPaymentCreateRequest
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/paths/~1stop-payments/post/requestBody/content/application~1json/schema/definitions/stopPayment"
}
},
"definitions": {
"stopPayment": {
"type": "object",
"title": "Stop Payment",
"required": [
"type",
"attributes",
"relationships"
],
"properties": {
"type": {
"type": "string",
"default": "stopPayment"
},
"attributes": {
"type": "object",
"required": [
"amount",
"checkNumber"
],
"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",
"maxLength": 255,
"minLength": 1
}
}
},
"relationships": {
"$ref": "#/paths/~1stop-payments/post/requestBody/content/application~1json/schema/definitions/relationships"
}
}
},
"relationships": {
"type": "object",
"required": [
"account"
],
"properties": {
"account": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"account",
"depositAccount",
"financialBusinessFBOAccount"
],
"type": "string"
}
}
}
}
}
}
}
}
}
StopPaymentCreateResponse
{
"type": "object",
"properties": {
"data": {
"type": "object",
"title": "Stop Payment",
"required": [
"type",
"id",
"attributes",
"relationships"
],
"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": "stopPayment"
},
"attributes": {
"type": "object",
"required": [
"createdAt",
"updatedAt",
"amount",
"checkNumber"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer",
"minimum": 1
},
"status": {
"enum": [
"Active",
"Disabled"
],
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"checkNumber": {
"type": "string"
}
}
},
"relationships": {
"type": "object",
"required": [
"account",
"customer"
],
"properties": {
"account": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"depositAccount",
"account"
],
"type": "string"
}
}
}
}
},
"customer": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"businessCustomer",
"individualCustomer",
"customer"
],
"type": "string"
}
}
}
}
},
"customers": {
"$ref": "#/paths/~1accounts/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateDepositAccount/properties/relationships/properties/customers"
},
"checkPayments": {
"type": "object",
"required": [
"data"
],
"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"
}
}
}
}
}
}
}
}
}
}
}
}
StopPaymentGetListResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/paths/~1stop-payments/post/responses/200/content/application~1json/schema/properties/data"
}
}
}
}
UnfreezeACardByIdResponse
{
"type": "object",
"title": "UnitCardResponse",
"properties": {
"data": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
UpdateAccountViaApiRequest
{
"type": "object",
"title": "Update Account",
"required": [
"data"
],
"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"
}
]
}
},
"definitions": {
"updateCreditAccount": {
"type": "object",
"title": "Update Credit Account",
"required": [
"type",
"attributes"
],
"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"
}
}
}
}
},
"updateDepositAccount": {
"type": "object",
"title": "Update Deposit Account",
"required": [
"type",
"attributes"
],
"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"
}
}
}
}
}
}
}
UpdateAccountViaApiResponse
{
"type": "object",
"title": "UnitAccountResponse",
"properties": {
"data": {
"$ref": "#/paths/~1accounts/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items"
}
}
}
UpdateApplicationViaApiRequest
{
"type": "object",
"title": "Patch Application",
"required": [
"data"
],
"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"
}
]
}
},
"definitions": {
"contact": {
"type": "object",
"title": "Contact",
"properties": {
"email": {
"type": "string",
"format": "email"
},
"phone": {
"type": "object",
"title": "Phone",
"required": [
"countryCode",
"number"
],
"properties": {
"number": {
"type": "string"
},
"countryCode": {
"type": "string"
}
}
},
"fullName": {
"type": "object",
"title": "Full Name",
"required": [
"first",
"last"
],
"properties": {
"last": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"first": {
"type": "string",
"maxLength": 255,
"minLength": 1
}
}
}
}
},
"grantor": {
"type": "object",
"title": "Grantor",
"properties": {
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"email": {
"type": "string",
"format": "email"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"address": {
"type": "object",
"title": "Address",
"required": [
"street",
"city",
"postalCode",
"country",
"state"
],
"properties": {
"city": {
"type": "string",
"pattern": "^.*$",
"maxLength": 255,
"minLength": 1
},
"state": {
"type": "string"
},
"street": {
"type": "string",
"pattern": "^.*$",
"maxLength": 255,
"minLength": 1
},
"country": {
"type": "string",
"default": "US"
},
"street2": {
"type": "string",
"pattern": "^.*$",
"nullable": true
},
"postalCode": {
"type": "string",
"pattern": "^[0-9]{5}(?:-[0-9]{4})?$"
}
}
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"passport": {
"type": "string"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"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"
}
}
},
"officer": {
"type": "object",
"title": "Officer",
"properties": {
"ssn": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/ssn"
},
"email": {
"type": "string",
"format": "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"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"passport": {
"type": "string"
},
"occupation": {
"enum": [
"ArchitectOrEngineer",
"BusinessAnalystAccountantOrFinancialAdvisor",
"CommunityAndSocialServicesWorker",
"ConstructionMechanicOrMaintenanceWorker",
"Doctor",
"Educator",
"EntertainmentSportsArtsOrMedia",
"ExecutiveOrManager",
"FarmerFishermanForester",
"FoodServiceWorker",
"GigWorker",
"HospitalityOfficeOrAdministrativeSupportWorker",
"HouseholdManager",
"JanitorHousekeeperLandscaper",
"Lawyer",
"ManufacturingOrProductionWorker",
"MilitaryOrPublicSafety",
"NurseHealthcareTechnicianOrHealthcareSupport",
"PersonalCareOrServiceWorker",
"PilotDriverOperator",
"SalesRepresentativeBrokerAgent",
"ScientistOrTechnologist",
"Student"
],
"type": "string"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"annualIncome": {
"enum": [
"UpTo10k",
"Between10kAnd25k",
"Between25kAnd50k",
"Between50kAnd100k",
"Between100kAnd250k",
"Over250k"
],
"type": "string"
},
"sourceOfIncome": {
"enum": [
"EmploymentOrPayrollIncome",
"PartTimeOrContractorIncome",
"InheritancesAndGifts",
"PersonalInvestments",
"BusinessOwnershipInterests",
"GovernmentBenefits"
],
"type": "string"
},
"matriculaConsular": {
"type": "string"
}
}
},
"beneficialOwner": {
"type": "object",
"title": "Beneficial Owner",
"properties": {
"ssn": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/ssn"
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"passport": {
"type": "string"
},
"occupation": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/officer/properties/occupation"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"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"
},
"matriculaConsular": {
"type": "string"
}
}
},
"patchTrustApplication": {
"type": "object",
"title": "Patch Trust Application",
"required": [
"type",
"attributes"
],
"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"
}
}
}
}
},
"patchBusinessApplication": {
"type": "object",
"title": "Patch Business Application",
"required": [
"type",
"attributes"
],
"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"
},
"website": {
"type": "string"
},
"cashFlow": {
"enum": [
"Unpredictable",
"Predictable"
],
"type": "string"
},
"stockSymbol": {
"type": "string"
},
"annualRevenue": {
"enum": [
"UpTo250k",
"Between250kAnd500k",
"Between500kAnd1m",
"Between1mAnd5m",
"Over5m"
],
"type": "string"
},
"businessVertical": {
"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"
],
"type": "string"
},
"numberOfEmployees": {
"enum": [
"UpTo10",
"Between10And50",
"Between50And100",
"Between100And500",
"Over500"
],
"type": "string"
},
"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
}
}
}
}
},
"patchIndividualApplication": {
"type": "object",
"title": "Patch Individual Application",
"required": [
"type",
"attributes"
],
"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"
}
}
}
}
},
"patchSoleProprietorApplication": {
"type": "object",
"title": "Patch Individual Application",
"required": [
"type",
"attributes"
],
"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"
},
"website": {
"type": "string"
},
"annualRevenue": {
"enum": [
"UpTo50k",
"Between50kAnd100k",
"Between100kAnd200k",
"Between200kAnd500k",
"Over500k"
],
"type": "string"
},
"businessVertical": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessApplication/properties/attributes/properties/businessVertical"
},
"numberOfEmployees": {
"enum": [
"One",
"Between2And5",
"Between5And10",
"Over10"
],
"type": "string"
}
}
}
}
},
"patchBusinessApplicationOfficer": {
"type": "object",
"title": "Patch Business Application",
"required": [
"type",
"attributes"
],
"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"
}
}
}
}
}
}
},
"patchBusinessApplicationBeneficialOwner": {
"type": "object",
"title": "Patch Business Application",
"required": [
"type",
"attributes"
],
"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"
}
}
}
}
}
}
}
}
UpdateCardViaApiRequest
{
"type": "object",
"title": "Patch Card",
"required": [
"data"
],
"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"
}
]
}
},
"definitions": {
"patchBusinessDebitCard": {
"type": "object",
"title": "Patch Business Debit Card",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"enum": [
"businessDebitCard"
],
"type": "string"
},
"attributes": {
"type": "object",
"required": [],
"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"
},
"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"
},
"design": {
"type": "string"
},
"limits": {
"type": "object",
"properties": {
"dailyPurchase": {
"type": "integer"
},
"dailyWithdrawal": {
"type": "integer"
},
"monthlyPurchase": {
"type": "integer"
},
"monthlyWithdrawal": {
"type": "integer"
}
}
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"shippingAddress": {
"$ref": "#/components/schemas/addressNullable"
},
"defaultFundingAccountId": {
"$ref": "#/components/schemas/idNullable"
}
}
}
}
},
"patchBusinessCreditCard": {
"type": "object",
"title": "Patch Business Credit Card",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"enum": [
"businessCreditCard"
],
"type": "string"
},
"attributes": {
"type": "object",
"required": [],
"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"
},
"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"
},
"design": {
"type": "string"
},
"limits": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessDebitCard/properties/attributes/properties/limits"
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"shippingAddress": {
"$ref": "#/components/schemas/addressNullable"
},
"defaultFundingAccountId": {
"$ref": "#/components/schemas/idNullable"
}
}
}
}
},
"patchIndividualDebitCard": {
"type": "object",
"title": "Patch Individual Debit Card",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"enum": [
"individualDebitCard"
],
"type": "string"
},
"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"
},
"design": {
"type": "string"
},
"limits": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessDebitCard/properties/attributes/properties/limits"
},
"shippingAddress": {
"$ref": "#/components/schemas/addressNullable"
},
"defaultFundingAccountId": {
"$ref": "#/components/schemas/idNullable"
}
}
}
}
},
"patchBusinessVirtualDebitCard": {
"type": "object",
"title": "Patch Business Virtual Debit Card",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"enum": [
"businessVirtualDebitCard"
],
"type": "string"
},
"attributes": {
"type": "object",
"required": [],
"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"
},
"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"
},
"limits": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessDebitCard/properties/attributes/properties/limits"
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"defaultFundingAccountId": {
"$ref": "#/components/schemas/idNullable"
}
}
}
}
},
"patchBusinessVirtualCreditCard": {
"type": "object",
"title": "Patch Business Virtual Credit Card",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"enum": [
"businessVirtualCreditCard"
],
"type": "string"
},
"attributes": {
"type": "object",
"required": [],
"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"
},
"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"
},
"limits": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchBusinessDebitCard/properties/attributes/properties/limits"
},
"address": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"defaultFundingAccountId": {
"$ref": "#/components/schemas/idNullable"
}
}
}
}
},
"patchIndividualVirtualDebitCard": {
"type": "object",
"title": "Patch Individual Virtual Debit Card",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"enum": [
"individualVirtualDebitCard"
],
"type": "string"
},
"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"
}
}
}
}
}
}
}
UpdateCardViaApiResponse
{
"type": "object",
"title": "UnitCardResponse",
"properties": {
"data": {
"type": "object",
"title": "Card Document",
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string"
}
},
"definitions": {
"pinStatus": {
"type": "object",
"title": "PinStatusDTO",
"properties": {
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"status": {
"type": "string"
}
}
}
}
},
"BusinessDebitCard": {
"type": "object",
"allOf": [
{
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data"
},
{
"type": "object",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"last4Digits",
"expirationDate",
"address",
"fullName",
"phone",
"email",
"dateOfBirth"
],
"properties": {
"bin": {
"type": "string",
"pattern": "^\\d{9}$"
},
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"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"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"design": {
"type": "string"
},
"status": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/physicalCardStatus"
},
"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"
},
"passport": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"last4Digits": {
"type": "string",
"pattern": "^\\d{4}$"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"freezeReason": {
"type": "string"
},
"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"
}
}
},
"relationships": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/cardRelationships"
}
}
}
],
"title": "Business Debit Card"
},
"cardRelationships": {
"type": "object",
"title": "cardRelationships",
"required": [
"account"
],
"properties": {
"account": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"account",
"depositAccount"
],
"type": "string"
}
}
}
}
},
"customer": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"businessCustomer",
"individualCustomer",
"customer"
],
"type": "string"
}
}
}
}
}
}
},
"virtualCardStatus": {
"enum": [
"Active",
"Inactive",
"Stolen",
"Lost",
"Frozen",
"ClosedByCustomer",
"Unknown",
"SuspectedFraud"
],
"type": "string"
},
"BusinessCreditCard": {
"type": "object",
"allOf": [
{
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data"
},
{
"type": "object",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"last4Digits",
"expirationDate",
"address",
"fullName",
"phone",
"email",
"dateOfBirth"
],
"properties": {
"bin": {
"type": "string",
"pattern": "^\\d{9}$"
},
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"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"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"design": {
"type": "string"
},
"status": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/physicalCardStatus"
},
"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"
},
"passport": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"last4Digits": {
"type": "string",
"pattern": "^\\d{4}$"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"freezeReason": {
"type": "string"
},
"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"
}
}
},
"relationships": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/cardRelationships"
}
}
}
],
"title": "Business Credit Card"
},
"physicalCardStatus": {
"enum": [
"Active",
"Inactive",
"Stolen",
"Lost",
"Frozen",
"ClosedByCustomer",
"Unknown",
"SuspectedFraud",
"ActiveForOnlineUse"
],
"type": "string"
},
"IndividualDebitCard": {
"type": "object",
"allOf": [
{
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data"
},
{
"type": "object",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"last4Digits",
"expirationDate",
"status"
],
"properties": {
"bin": {
"type": "string",
"pattern": "^\\d{9}$"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"design": {
"type": "string"
},
"status": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/physicalCardStatus"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"last4Digits": {
"type": "string",
"pattern": "^\\d{4}$"
},
"freezeReason": {
"type": "string"
},
"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"
}
}
},
"relationships": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/cardRelationships"
}
}
}
],
"title": "Individual Debit Card"
},
"BusinessVirtualDebitCard": {
"type": "object",
"allOf": [
{
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data"
},
{
"type": "object",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"last4Digits",
"expirationDate",
"address",
"fullName",
"phone",
"email",
"dateOfBirth"
],
"properties": {
"bin": {
"type": "string",
"pattern": "^\\d{9}$"
},
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"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"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"status": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/virtualCardStatus"
},
"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"
},
"passport": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"last4Digits": {
"type": "string",
"pattern": "^\\d{4}$"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"freezeReason": {
"type": "string"
},
"expirationDate": {
"type": "string",
"pattern": "^\\d{4}[-](1[012]|0[1-9])$"
}
}
},
"relationships": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/cardRelationships"
}
}
}
],
"title": "Business Virtual Debit Card"
},
"BusinessVirtualCreditCard": {
"type": "object",
"allOf": [
{
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data"
},
{
"type": "object",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"last4Digits",
"expirationDate",
"address",
"fullName",
"phone",
"email",
"dateOfBirth"
],
"properties": {
"bin": {
"type": "string",
"pattern": "^\\d{9}$"
},
"ssn": {
"type": "string",
"pattern": "^\\d{9}$"
},
"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"
},
"phone": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/phone"
},
"status": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/virtualCardStatus"
},
"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"
},
"passport": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"dateOfBirth": {
"type": "string",
"format": "date"
},
"last4Digits": {
"type": "string",
"pattern": "^\\d{4}$"
},
"nationality": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/nationality"
},
"freezeReason": {
"type": "string"
},
"expirationDate": {
"type": "string",
"pattern": "^\\d{4}[-](1[012]|0[1-9])$"
}
}
},
"relationships": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/cardRelationships"
}
}
}
],
"title": "Business Virtual Credit Card"
},
"IndividualVirtualDebitCard": {
"type": "object",
"allOf": [
{
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data"
},
{
"type": "object",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"last4Digits",
"expirationDate",
"status"
],
"properties": {
"bin": {
"type": "string",
"pattern": "^\\d{9}$"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"status": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/virtualCardStatus"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"last4Digits": {
"type": "string",
"pattern": "^\\d{4}$"
},
"freezeReason": {
"type": "string"
},
"expirationDate": {
"type": "string",
"pattern": "^\\d{4}[-](1[012]|0[1-9])$"
}
}
},
"relationships": {
"$ref": "#/paths/~1cards~1%7BcardId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/cardRelationships"
}
}
}
],
"title": "Individual Virtual Debit Card"
}
},
"discriminator": {
"mapping": {
"businessDebitCard": "#/definitions/BusinessDebitCard",
"businessCreditCard": "#/definitions/BusinessCreditCard",
"individualDebitCard": "#/definitions/IndividualDebitCard",
"businessVirtualDebitCard": "#/definitions/BusinessVirtualDebitCard",
"businessVirtualCreditCard": "#/definitions/BusinessVirtualCreditCard",
"individualVirtualDebitCard": "#/definitions/IndividualVirtualDebitCard"
},
"propertyName": "type"
}
}
}
}
UpdateCheckDepositByIdRequest
{
"type": "object",
"title": "Patch Check Deposit",
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/paths/~1check-deposits~1%7BcheckDepositId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchCheckDeposit"
}
},
"definitions": {
"patchCheckDeposit": {
"type": "object",
"title": "Patch Check Deposit",
"required": [
"type",
"attributes"
],
"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
}
}
}
}
}
}
}
UpdateCheckDepositByIdResponse
{
"type": "object",
"title": "UnitCheckDepositResponse",
"properties": {
"data": {
"$ref": "#/paths/~1check-deposits/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
UpdateCounterpartyViaApiRequest
{
"type": "object",
"title": "Patch Counterparty",
"required": [
"data"
],
"properties": {
"data": {
"oneOf": [
{
"$ref": "#/paths/~1counterparties~1%7BcounterpartyId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchCounterparty"
}
]
}
},
"definitions": {
"patchCounterparty": {
"type": "object",
"title": "Patch Counterparty",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"default": "counterparty"
},
"attributes": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 50,
"minLength": 1
},
"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"
},
"verifyName": {
"type": "boolean",
"default": false
},
"permissions": {
"enum": [
"CreditOnly",
"DebitOnly",
"CreditAndDebit"
],
"type": "string"
},
"plaidProcessorToken": {
"type": "string",
"pattern": "^processor-.*$",
"maxLength": 60,
"minLength": 40
}
}
}
}
}
}
}
UpdateCounterpartyViaApiResponse
{
"type": "object",
"title": "UnitCounterpartyResponse",
"properties": {
"data": {
"$ref": "#/paths/~1counterparties/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
UpdateCustomerViaApiRequest
{
"type": "object",
"title": "Patch Customer",
"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"
}
]
}
},
"definitions": {
"relationships": {
"type": "object",
"properties": {
"org": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"id",
"type"
],
"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"
}
}
}
}
},
"application": {
"type": "object",
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"businessApplication",
"individualApplication"
],
"type": "string"
}
}
}
}
},
"updateTrustCustomer": {
"type": "object",
"title": "UpdateTrustCustomer",
"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": {
"type": "object",
"title": "Authorized User",
"required": [
"fullName",
"email",
"phone"
],
"properties": {
"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"
},
"fullName": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/contact/properties/fullName"
},
"jwtSubject": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent/properties/jwtSubject"
}
}
},
"nullable": true
}
}
}
}
},
"updateBusinessCustomer": {
"type": "object",
"title": "UpdateBusinessCustomer",
"properties": {
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"dba": {
"type": "string",
"nullable": true
},
"ein": {
"type": "string",
"pattern": "^\\d{9}$"
},
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags",
"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
},
"contact": {
"allOf": [
{
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateBusinessApplication/properties/attributes/properties/contact"
}
],
"nullable": true,
"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
}
}
}
}
},
"updateIndividualCustomer": {
"type": "object",
"title": "UpdateIndividualCustomer",
"properties": {
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"dba": {
"type": "string",
"nullable": true
},
"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
},
"jwtSubject": {
"$ref": "#/paths/~1applications/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/createPowerOfAttorneyAgent/properties/jwtSubject",
"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
}
}
}
}
}
}
}
UpdateCustomerViaApiResponse
{
"type": "object",
"title": "UnitCustomerResponse",
"properties": {
"data": {
"$ref": "#/paths/~1customers/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/items"
}
}
}
UpdatePaymentViaApiRequest
{
"type": "object",
"title": "Patch Payment",
"required": [
"data"
],
"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"
}
]
}
},
"definitions": {
"patchAchPayment": {
"type": "object",
"title": "Patch ACH Payment",
"required": [
"type",
"attributes"
],
"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"
}
}
}
}
},
"patchBookPayment": {
"type": "object",
"title": "Patch Book Payment",
"required": [
"type",
"attributes"
],
"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"
}
}
}
}
}
}
}
UpdatePaymentViaApiResponse
{
"type": "object",
"title": "UnitPaymentResponse",
"properties": {
"data": {
"$ref": "#/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data"
}
}
}
UpdateReceivedPaymentViaApiRequest
{
"type": "object",
"title": "Patch Received Payment",
"required": [
"data"
],
"properties": {
"data": {
"oneOf": [
{
"$ref": "#/paths/~1received-payments~1%7BpaymentId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/patchAchReceivedPayment"
}
]
}
},
"definitions": {
"patchAchReceivedPayment": {
"type": "object",
"title": "Patch ACH Received Payment",
"required": [
"type",
"attributes"
],
"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"
}
}
}
}
}
}
}
UpdateReceivedPaymentViaApiResponse
{
"type": "object",
"title": "UnitReceivedPaymentResponse",
"properties": {
"data": {
"$ref": "#/paths/~1received-payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data"
}
}
}
UpdateTransactionViaApiRequest
{
"type": "object",
"title": "Patch Transaction",
"required": [
"data"
],
"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"
}
]
}
},
"definitions": {
"accountRelationship": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"account",
"depositAccount",
"creditAccount",
"batchAccount"
],
"type": "string"
}
}
}
}
},
"patchBookTransaction": {
"type": "object",
"title": "Patch Book Transaction",
"required": [
"type",
"attributes"
],
"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",
"required": [
"account"
],
"properties": {
"account": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship"
}
}
}
}
},
"patchTransactionTags": {
"type": "object",
"title": "Patch Transaction",
"required": [
"type",
"attributes"
],
"properties": {
"type": {
"type": "string",
"default": "transaction"
},
"attributes": {
"type": "object",
"required": [
"tags"
],
"properties": {
"tags": {
"type": "object",
"maxProperties": 15
}
}
}
}
},
"patchChargebackTransaction": {
"type": "object",
"title": "Patch Chargeback Transaction",
"required": [
"type",
"attributes"
],
"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",
"required": [
"account"
],
"properties": {
"account": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/accountRelationship"
}
}
}
}
}
}
}
UpdateTransactionViaApiResponse
{
"type": "object",
"title": "UnitTransactionResponse",
"properties": {
"data": {
"type": "object",
"title": "Transaction Resource",
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"type": "string"
}
},
"definitions": {
"AtmTransaction": {
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary",
"cardLast4Digits",
"atmName",
"surcharge"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"atmName": {
"type": "string"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
},
"surcharge": {
"type": "integer"
},
"atmLocation": {
"type": "string"
},
"cardNetwork": {
"type": "string"
},
"interchange": {
"type": "string",
"nullable": true
},
"cardLast4Digits": {
"type": "string"
},
"networkTransactionId": {
"type": "string"
},
"internationalServiceFee": {
"type": "integer",
"nullable": true
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "ATM"
},
"FeeTransaction": {
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "Fee"
},
"BookTransaction": {
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary",
"counterparty"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"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"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "Book"
},
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary",
"cardLast4Digits",
"merchant",
"recurring"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"summary": {
"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"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
},
"recurring": {
"type": "boolean"
},
"cardNetwork": {
"type": "string"
},
"interchange": {
"type": "string",
"nullable": true
},
"digitalWallet": {
"type": "string"
},
"paymentMethod": {
"type": "string"
},
"cardLast4Digits": {
"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"
},
"networkTransactionId": {
"type": "string"
},
"internationalServiceFee": {
"type": "integer",
"nullable": true
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "cardTransaction"
},
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary",
"counterparty"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"imadOmad": {
"type": "object",
"properties": {
"imad": {
"type": "string"
},
"omad": {
"type": "string"
}
}
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
},
"description": {
"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"
},
"senderReference": {
"type": "string"
},
"beneficiaryInformation": {
"type": "string"
},
"referenceForBeneficiary": {
"type": "string"
},
"beneficiaryAdviceInformation": {
"type": "string"
},
"originatorToBeneficiaryInformation": {
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "wireTransaction"
},
"RewardTransaction": {
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary",
"receiverCounterparty"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
},
"receiverCounterparty": {
"$ref": "#/paths/~1payments~1%7BpaymentId%7D/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/properties/data/definitions/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"
}
}
}
],
"title": "Reward"
},
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "billPayTransaction"
},
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary",
"reason",
"disputeId"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"reason": {
"type": "string"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
},
"disputeId": {
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "disputeTransaction"
},
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary",
"counterparty"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
},
"senderName": {
"type": "string"
},
"description": {
"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"
},
"senderAddress": {
"$ref": "#/paths/~1applications~1%7BapplicationId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/grantor/properties/address"
},
"senderAccountNumber": {
"type": "string",
"maxLength": 17
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "releaseTransaction"
},
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "interestTransaction"
},
"PurchaseTransaction": {
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary",
"cardLast4Digits",
"merchant",
"recurring",
"ecommerce",
"cardPresent"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"summary": {
"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"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
},
"ecommerce": {
"type": "boolean"
},
"recurring": {
"type": "boolean"
},
"cardNetwork": {
"type": "string"
},
"cardPresent": {
"type": "boolean"
},
"coordinates": {
"$ref": "#/paths/~1atm-locations/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/attributes/properties/coordinates"
},
"interchange": {
"type": "string",
"nullable": true
},
"digitalWallet": {
"type": "string"
},
"paymentMethod": {
"type": "string"
},
"cardLast4Digits": {
"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"
},
"networkTransactionId": {
"type": "string"
},
"internationalServiceFee": {
"type": "integer",
"nullable": true
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "Purchase"
},
"ReversalTransaction": {
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary",
"cardLast4Digits"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
},
"cardLast4Digits": {
"type": "string"
},
"networkTransactionId": {
"type": "string"
},
"internationalServiceFee": {
"type": "integer",
"nullable": true
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "Reversal"
},
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
},
"description": {
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "adjustmentTransaction"
},
"ChargebackTransaction": {
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"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"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "Chargeback"
},
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "settlementTransaction"
},
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary",
"cardLast4Digits",
"merchant",
"recurring"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
},
"recurring": {
"type": "boolean"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "cashDepositTransaction"
},
"InterchangeTransaction": {
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "interchangeShareTransaction"
},
"ReceivedAchTransaction": {
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary",
"description",
"companyName",
"counterpartyRoutingNumber"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"addenda": {
"type": "string"
},
"balance": {
"type": "integer"
},
"secCode": {
"type": "string",
"maxLength": 3,
"minLength": 3
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
},
"companyName": {
"type": "string"
},
"description": {
"type": "string"
},
"traceNumber": {
"type": "string"
},
"counterpartyName": {
"type": "string"
},
"counterpartyRoutingNumber": {
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "Received ACH"
},
"ReturnedAchTransaction": {
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary",
"companyName",
"counterpartyName",
"counterpartyRoutingNumber",
"reason"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"reason": {
"type": "string"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"achReason": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
},
"companyName": {
"type": "string"
},
"counterpartyName": {
"type": "string"
},
"counterpartyRoutingNumber": {
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "Returned ACH"
},
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "checkDepositTransaction"
},
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "checkPaymentTransaction"
},
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary",
"paidForDate"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
},
"paidForDate": {
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "bankRepaymentTransaction"
},
"DishonoredAchTransaction": {
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary",
"description",
"companyName",
"counterpartyRoutingNumber"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"reason": {
"type": "string"
},
"balance": {
"type": "integer"
},
"secCode": {
"type": "string",
"maxLength": 3,
"minLength": 3
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
},
"companyName": {
"type": "string"
},
"description": {
"type": "string"
},
"traceNumber": {
"type": "string"
},
"counterpartyName": {
"type": "string"
},
"counterpartyRoutingNumber": {
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "Dishonored Return ACH"
},
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "interestShareTransaction"
},
"OriginatedAchTransaction": {
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary",
"description",
"counterparty"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"addenda": {
"type": "string"
},
"balance": {
"type": "integer"
},
"secCode": {
"type": "string"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
},
"description": {
"type": "string"
},
"traceNumber": {
"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"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "Originated ACH"
},
"transactionRelationships": {
"type": "object",
"title": "transactionRelationships",
"required": [
"account"
],
"properties": {
"org": {
"$ref": "#/paths/~1customers~1%7BcustomerId%7D/patch/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/relationships/properties/org"
},
"card": {
"type": "object",
"title": "cardRelationship",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "card"
}
}
}
}
},
"reward": {
"type": "object",
"title": "rewardRelationship",
"required": [
"type",
"id"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "reward"
}
}
}
}
},
"account": {
"type": "object",
"title": "accountRelationship",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"depositAccount",
"glAccount",
"account"
],
"type": "string"
}
}
}
}
},
"payment": {
"type": "object",
"title": "paymentRelationship",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "payment"
}
}
}
}
},
"customer": {
"type": "object",
"title": "customerRelationship",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"businessCustomer",
"individualCustomer",
"customer"
],
"type": "string"
}
}
}
}
},
"returned": {
"type": "object",
"title": "returnedRelationship",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "transaction"
}
}
}
}
},
"customers": {
"$ref": "#/paths/~1accounts/post/requestBody/content/application~1vnd.api%2Bjson/schema/definitions/CreateDepositAccount/properties/relationships/properties/customers"
},
"repayment": {
"type": "object",
"title": "repaymentRelationship",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "repayment"
}
}
}
}
},
"chargeback": {
"type": "object",
"title": "chargebackRelationship",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "chargeback"
}
}
}
}
},
"incomingAch": {
"type": "object",
"title": "incomingAchRelationship",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "incomingAch"
}
}
}
}
},
"checkDeposit": {
"type": "object",
"title": "checkDepositRelationship",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "checkDeposit"
}
}
}
}
},
"checkPayment": {
"type": "object",
"title": "checkPaymentRelationship",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "payment"
}
}
}
}
},
"authorization": {
"type": "object",
"title": "authorizationRelationship",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "authorization"
}
}
}
}
},
"receivedPayment": {
"type": "object",
"title": "receivedPaymentRelationship",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "receivedPayment"
}
}
}
}
},
"receivingAccount": {
"type": "object",
"title": "receivingAccountRelationship",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"properties": {
"id": {
"$ref": "#/paths/~1disputes/get/responses/200/content/application~1vnd.api%2Bjson%3B%20charset%3Dutf-8/schema/items/properties/id"
},
"type": {
"enum": [
"depositAccount",
"account"
],
"type": "string"
}
}
}
}
},
"recurringPayment": {
"type": "object",
"title": "recurringPaymentRelationship",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "recurringPayment"
}
}
}
}
},
"relatedTransaction": {
"type": "object",
"title": "relatedTransactionRelationship",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "transaction"
}
}
}
}
},
"counterpartyAccount": {
"type": "object",
"title": "counterpartyAccountRelationship",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "account"
}
}
}
}
},
"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"
},
"authorizationRequest": {
"type": "object",
"title": "authorizationRequestRelationship",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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": "authorizationRequest"
}
}
}
}
},
"counterpartyCustomer": {
"type": "object",
"title": "counterpartyCustomerRelationship",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"type",
"id"
],
"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"
}
}
}
}
},
"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"
}
}
},
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "paymentAdvanceTransaction"
},
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"reason": {
"type": "string"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "paymentCanceledTransaction"
},
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "customerRepaymentTransaction"
},
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "disputeSettlementTransaction"
},
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "sponsoredInterestTransaction"
},
"ReturnedReceivedAchTransaction": {
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary",
"companyName",
"reason"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"reason": {
"type": "string"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
},
"companyName": {
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "Returned Received ACH"
},
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "repaidPaymentAdvanceTransaction"
},
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"reason": {
"type": "string"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "returnedCheckDepositTransaction"
},
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary",
"reason"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"reason": {
"type": "string"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "returnedCheckPaymentTransaction"
},
"NegativeBalanceCoverageTransaction": {
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "NegativeBalanceCoverage"
},
"AccountLowBalanceClosureTransaction": {
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"balance",
"summary"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "AccountLowBalanceClosure"
},
"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",
"required": [
"attributes",
"relationships"
],
"properties": {
"attributes": {
"type": "object",
"required": [
"createdAt",
"amount",
"direction",
"balance",
"summary"
],
"properties": {
"tags": {
"$ref": "#/paths/~1fees/post/requestBody/content/application~1vnd.api%2Bjson/schema/data/properties/attributes/properties/tags"
},
"amount": {
"type": "integer"
},
"balance": {
"type": "integer"
},
"summary": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"direction": {
"enum": [
"Credit",
"Debit"
],
"type": "string"
}
}
},
"relationships": {
"$ref": "#/paths/~1accounts~1%7BaccountId%7D~1transactions~1%7BtransactionId%7D/patch/responses/200/content/application~1vnd.api%2Bjson/schema/properties/data/definitions/transactionRelationships"
}
}
}
],
"title": "customerRepaymentReturnedTransaction"
}
},
"discriminator": {
"mapping": {
"atmTransaction": "#/definitions/AtmTransaction",
"feeTransaction": "#/definitions/FeeTransaction",
"bookTransaction": "#/definitions/BookTransaction",
"cardTransaction": "#/definitions/CardTransaction",
"wireTransaction": "#/definitions/WireTransaction",
"rewardTransaction": "#/definitions/RewardTransaction",
"billPayTransaction": "#/definitions/BillPayTransaction",
"disputeTransaction": "#/definitions/DisputeTransaction",
"releaseTransaction": "#/definitions/ReleaseTransaction",
"interestTransaction": "#/definitions/InterestTransaction",
"purchaseTransaction": "#/definitions/PurchaseTransaction",
"reversalTransaction": "#/definitions/ReversalTransaction",
"adjustmentTransaction": "#/definitions/AdjustmentTransaction",
"chargebackTransaction": "#/definitions/ChargebackTransaction",
"settlementTransaction": "#/definitions/SettlementTransaction",
"cashDepositTransaction": "#/definitions/CashDepositTransaction",
"interchangeTransaction": "#/definitions/InterchangeTransaction",
"receivedAchTransaction": "#/definitions/ReceivedAchTransaction",
"returnedAchTransaction": "#/definitions/ReturnedAchTransaction",
"checkDepositTransaction": "#/definitions/CheckDepositTransaction",
"checkPaymentTransaction": "#/definitions/CheckPaymentTransaction",
"bankRepaymentTransaction": "#/definitions/BankRepaymentTransaction",
"dishonoredAchTransaction": "#/definitions/DishonoredAchTransaction",
"interestShareTransaction": "#/definitions/InterestShareTransaction",
"originatedAchTransaction": "#/definitions/OriginatedAchTransaction",
"paymentAdvanceTransaction": "#/definitions/PaymentAdvanceTransaction",
"customerRepaymentTransaction": "#/definitions/CustomerRepaymentTransaction",
"disputeSettlementTransaction": "#/definitions/DisputeSettlementTransaction",
"sponsoredInterestTransaction": "#/definitions/SponsoredInterestTransaction",
"returnedReceivedAchTransaction": "#/definitions/ReturnedReceivedAchTransaction",
"repaidPaymentAdvanceTransaction": "#/definitions/RepaidPaymentAdvanceTransaction",
"returnedCheckDepositTransaction": "#/definitions/ReturnedCheckDepositTransaction",
"returnedCheckPaymentTransaction": "#/definitions/ReturnedCheckPaymentTransaction",
"negativeBalanceCoverageTransaction": "#/definitions/NegativeBalanceCoverageTransaction",
"accountLowBalanceClosureTransaction": "#/definitions/AccountLowBalanceClosureTransaction",
"customerRepaymentReturnedTransaction": "#/definitions/CustomerRepaymentReturnedTransaction"
},
"propertyName": "type"
}
}
}
}
UpdateWebhookViaApiRequest
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"tags": {
"type": "object"
}
}
}
}
}
}
}
UpdateWebhookViaApiResponse
{
"type": "object",
"title": "UnitWebhookResponse",
"properties": {
"data": {
"$ref": "#/paths/~1webhooks/post/responses/201/content/application~1vnd.api%2Bjson/schema/properties/data"
}
}
}
UploadAJpegDocumentForAnApplicationBackSidePutRequest
{
"type": "object"
}
UploadAJpegDocumentForAnApplicationViaApiRequest
{
"type": "object"
}
UploadAPngDocumentForAnApplicationBackSidePutRequest
{
"type": "object"
}
UploadAPngDocumentForAnApplicationByIdRequest
{
"type": "object"
}
VerifyADocumentForAnApplicationPutRequest
{
"type": "object",
"title": "VerifyDocument",
"properties": {
"jobId": {
"type": "string"
}
}
}
addressNullable
{
"type": "object",
"title": "Address",
"nullable": true,
"required": [
"street",
"city",
"postalCode",
"country",
"state"
],
"properties": {
"city": {
"type": "string",
"pattern": "^.*$",
"maxLength": 255,
"minLength": 1
},
"state": {
"type": "string"
},
"street": {
"type": "string",
"pattern": "^.*$",
"maxLength": 255,
"minLength": 1
},
"country": {
"type": "string",
"default": "US"
},
"street2": {
"type": "string",
"pattern": "^.*$",
"nullable": true
},
"postalCode": {
"type": "string",
"pattern": "^[0-9]{5}(?:-[0-9]{4})?$"
}
}
}
idNullable
{
"type": "string",
"pattern": "^[1-9]\\d*$",
"nullable": true
}
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
}