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"
}
}
}