Skip to content

Instantly share code, notes, and snippets.

@cchen408

cchen408/apiv3-20150831.json

Created September 1, 2015 03:36
Show Gist options
  • Save cchen408/a6cc880b5ac5485d663e to your computer and use it in GitHub Desktop.
Save cchen408/a6cc880b5ac5485d663e to your computer and use it in GitHub Desktop.
Download ZIP
new swagger file
Raw
apiv3-20150831.json
{
"swagger": "2.0",
"info": {
"version": "3.0.0",
"title": "Title was not specified"
},
"paths": {
"/Applications": {
"post": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Application"
}
}
},
"description": "",
"tags": [
"Applications"
],
"summary": "Create a new instance of the model and persist it into the data source.",
"operationId": "create",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "body",
"description": "Model instance data",
"name": "data",
"required": false,
"schema": {
"$ref": "#/definitions/Application"
}
}
]
}
},
"/Applications/{id}": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Application"
}
}
},
"description": "",
"tags": [
"Applications"
],
"summary": "Find a model instance by id from the data source.",
"operationId": "findById",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "path",
"description": "Model id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
},
{
"in": "query",
"description": "Filter defining fields and include",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/definitions/object"
}
}
]
},
"put": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Application"
}
}
},
"description": "",
"tags": [
"Applications"
],
"summary": "Update attributes for a model instance and persist it into the data source.",
"operationId": "prototype.updateAttributes",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "body",
"description": "An object of model property name/value pairs",
"name": "data",
"required": false,
"schema": {
"$ref": "#/definitions/Application"
}
},
{
"in": "path",
"description": "PersistedModel id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
}
},
"/BankAccounts/{id}/token": {
"post": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Token"
}
}
},
"description": "",
"tags": [
"BankAccounts"
],
"summary": "Creates a new instance in token of this model.",
"operationId": "prototype.__create__token",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "body",
"name": "data",
"required": false,
"schema": {
"$ref": "#/definitions/Token"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
}
},
"/BankAccounts/{id}": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/BankAccount"
}
}
},
"description": "",
"tags": [
"BankAccounts"
],
"summary": "Find a model instance by id from the data source.",
"operationId": "findById",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "path",
"description": "Model id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
},
{
"in": "query",
"description": "Filter defining fields and include",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/definitions/object"
}
}
]
}
},
"/BankDrops/{id}": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/BankDrop"
}
}
},
"description": "",
"tags": [
"BankDrops"
],
"summary": "Find a model instance by id from the data source.",
"operationId": "findById",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "path",
"description": "Model id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
},
{
"in": "query",
"description": "Filter defining fields and include",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/definitions/object"
}
}
]
},
"put": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/BankDrop"
}
}
},
"description": "",
"tags": [
"BankDrops"
],
"summary": "Update attributes for a model instance and persist it into the data source.",
"operationId": "prototype.updateAttributes",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "body",
"description": "An object of model property name/value pairs",
"name": "data",
"required": false,
"schema": {
"$ref": "#/definitions/BankDrop"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
}
},
"/BankLogins/{id}/accounts": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"type": "array",
"items": {
"type": "BankAccount"
}
}
}
},
"description": "",
"tags": [
"BankLogins"
],
"summary": "Queries accounts of BankLogin.",
"operationId": "prototype.__get__accounts",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/definitions/object"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
}
},
"/BankLogins/{id}": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/BankLogin"
}
}
},
"description": "",
"tags": [
"BankLogins"
],
"summary": "Find a model instance by id from the data source.",
"operationId": "findById",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "path",
"description": "Model id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
},
{
"in": "query",
"description": "Filter defining fields and include",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/definitions/object"
}
}
]
},
"put": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/BankLogin"
}
}
},
"description": "",
"tags": [
"BankLogins"
],
"summary": "Update attributes for a model instance and persist it into the data source.",
"operationId": "prototype.updateAttributes",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "body",
"description": "An object of model property name/value pairs",
"name": "data",
"required": false,
"schema": {
"$ref": "#/definitions/BankLogin"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
}
},
"/BankLogins/banks": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"type": "string"
}
}
},
"description": "",
"tags": [
"BankLogins"
],
"summary": "Get list of banks with bank login supported",
"operationId": "banks",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
]
}
},
"/Banks/{id}/drop": {
"post": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/BankDrop"
}
}
},
"description": "",
"tags": [
"Banks"
],
"summary": "Creates a new instance in drop of this model.",
"operationId": "prototype.__create__drop",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "body",
"name": "data",
"required": false,
"schema": {
"$ref": "#/definitions/BankDrop"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
}
},
"/Banks/{id}": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Bank"
}
}
},
"description": "",
"tags": [
"Banks"
],
"summary": "Find a model instance by id from the data source.",
"operationId": "findById",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "path",
"description": "Model id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
},
{
"in": "query",
"description": "Filter defining fields and include",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/definitions/object"
}
}
]
},
"put": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Bank"
}
}
},
"description": "",
"tags": [
"Banks"
],
"summary": "Update attributes for a model instance and persist it into the data source.",
"operationId": "prototype.updateAttributes",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "body",
"description": "An object of model property name/value pairs",
"name": "data",
"required": false,
"schema": {
"$ref": "#/definitions/Bank"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
}
},
"/Cards/{id}": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Card"
}
}
},
"description": "",
"tags": [
"Cards"
],
"summary": "Find a model instance by id from the data source.",
"operationId": "findById",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "path",
"description": "Model id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
},
{
"in": "query",
"description": "Filter defining fields and include",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/definitions/object"
}
}
]
},
"put": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Card"
}
}
},
"description": "",
"tags": [
"Cards"
],
"summary": "Update attributes for a model instance and persist it into the data source.",
"operationId": "prototype.updateAttributes",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "body",
"description": "An object of model property name/value pairs",
"name": "data",
"required": false,
"schema": {
"$ref": "#/definitions/Card"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
}
},
"/Customers/{id}/banks": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"type": "array",
"items": {
"type": "Bank"
}
}
}
},
"description": "",
"tags": [
"Customers"
],
"summary": "Queries banks of Customer.",
"operationId": "prototype.__get__banks",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/definitions/object"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
}
},
"/Customers/{id}/cards": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"type": "array",
"items": {
"type": "Card"
}
}
}
},
"description": "",
"tags": [
"Customers"
],
"summary": "Queries cards of Customer.",
"operationId": "prototype.__get__cards",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/definitions/object"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
}
},
"/Customers/{id}/users": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"type": "array",
"items": {
"type": "User"
}
}
}
},
"description": "",
"tags": [
"Customers"
],
"summary": "Queries users of Customer.",
"operationId": "prototype.__get__users",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/definitions/object"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
}
},
"/Customers/{id}/disputes": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"type": "array",
"items": {
"type": "Dispute"
}
}
}
},
"description": "",
"tags": [
"Customers"
],
"summary": "Queries disputes of Customer.",
"operationId": "prototype.__get__disputes",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/definitions/object"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
}
},
"/Customers/{id}/events": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"type": "array",
"items": {
"type": "Event"
}
}
}
},
"description": "",
"tags": [
"Customers"
],
"summary": "Queries events of Customer.",
"operationId": "prototype.__get__events",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/definitions/object"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
}
},
"/Customers/{id}/payments": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"type": "array",
"items": {
"type": "Payment"
}
}
}
},
"description": "",
"tags": [
"Customers"
],
"summary": "Queries payments of Customer.",
"operationId": "prototype.__get__payments",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/definitions/object"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
},
"post": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Payment"
}
}
},
"description": "",
"tags": [
"Customers"
],
"summary": "Creates a new instance in payments of this model.",
"operationId": "prototype.__create__payments",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "body",
"name": "data",
"required": false,
"schema": {
"$ref": "#/definitions/Payment"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
}
},
"/Customers/{id}/refunds": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"type": "array",
"items": {
"type": "Refund"
}
}
}
},
"description": "",
"tags": [
"Customers"
],
"summary": "Queries refunds of Customer.",
"operationId": "prototype.__get__refunds",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/definitions/object"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
}
},
"/Customers/{id}/tokens": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"type": "array",
"items": {
"type": "Token"
}
}
}
},
"description": "",
"tags": [
"Customers"
],
"summary": "Queries tokens of Customer.",
"operationId": "prototype.__get__tokens",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/definitions/object"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
},
"post": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Token"
}
}
},
"description": "",
"tags": [
"Customers"
],
"summary": "Creates a new instance in tokens of this model.",
"operationId": "prototype.__create__tokens",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "body",
"name": "data",
"required": false,
"schema": {
"$ref": "#/definitions/Token"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
}
},
"/Customers/{id}/withdrawals": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"type": "array",
"items": {
"type": "Withdrawal"
}
}
}
},
"description": "",
"tags": [
"Customers"
],
"summary": "Queries withdrawals of Customer.",
"operationId": "prototype.__get__withdrawals",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/definitions/object"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
},
"post": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Withdrawal"
}
}
},
"description": "",
"tags": [
"Customers"
],
"summary": "Creates a new instance in withdrawals of this model.",
"operationId": "prototype.__create__withdrawals",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "body",
"name": "data",
"required": false,
"schema": {
"$ref": "#/definitions/Withdrawal"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
}
},
"/Customers/{id}/banklogins": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"type": "array",
"items": {
"type": "BankLogin"
}
}
}
},
"description": "",
"tags": [
"Customers"
],
"summary": "Queries banklogins of Customer.",
"operationId": "prototype.__get__banklogins",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/definitions/object"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
},
"post": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/BankLogin"
}
}
},
"description": "",
"tags": [
"Customers"
],
"summary": "Creates a new instance in banklogins of this model.",
"operationId": "prototype.__create__banklogins",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "body",
"name": "data",
"required": false,
"schema": {
"$ref": "#/definitions/BankLogin"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
}
},
"/Customers": {
"post": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Customer"
}
}
},
"description": "",
"tags": [
"Customers"
],
"summary": "Create a new instance of the model and persist it into the data source.",
"operationId": "create",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "body",
"description": "Model instance data",
"name": "data",
"required": false,
"schema": {
"$ref": "#/definitions/Customer"
}
}
]
}
},
"/Customers/{id}": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Customer"
}
}
},
"description": "",
"tags": [
"Customers"
],
"summary": "Find a model instance by id from the data source.",
"operationId": "findById",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "path",
"description": "Model id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
},
{
"in": "query",
"description": "Filter defining fields and include",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/definitions/object"
}
}
]
},
"put": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Customer"
}
}
},
"description": "",
"tags": [
"Customers"
],
"summary": "Update attributes for a model instance and persist it into the data source.",
"operationId": "prototype.updateAttributes",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "body",
"description": "An object of model property name/value pairs",
"name": "data",
"required": false,
"schema": {
"$ref": "#/definitions/Customer"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
}
},
"/Customers/{id}/onboard": {
"post": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Customer"
}
}
},
"description": "",
"tags": [
"Customers"
],
"summary": "Onboard an existing customer",
"operationId": "idOnboard",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": false,
"type": "string"
},
{
"in": "body",
"name": "underwriting",
"required": false,
"schema": {
"$ref": "#/definitions/Underwriting"
}
}
]
}
},
"/Customers/{id}/verbose": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Customer"
}
}
},
"description": "",
"tags": [
"Customers"
],
"summary": "Get a customer record and its common relationships",
"operationId": "verbose",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": false,
"type": "string"
}
]
}
},
"/Disputes/{id}": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Dispute"
}
}
},
"description": "",
"tags": [
"Disputes"
],
"summary": "Find a model instance by id from the data source.",
"operationId": "findById",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "path",
"description": "Model id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
},
{
"in": "query",
"description": "Filter defining fields and include",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/definitions/object"
}
}
]
},
"put": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Dispute"
}
}
},
"description": "",
"tags": [
"Disputes"
],
"summary": "Update attributes for a model instance and persist it into the data source.",
"operationId": "prototype.updateAttributes",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "body",
"description": "An object of model property name/value pairs",
"name": "data",
"required": false,
"schema": {
"$ref": "#/definitions/Dispute"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
}
},
"/Disputes/{id}/verbose": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Dispute"
}
}
},
"description": "",
"tags": [
"Disputes"
],
"summary": "Get a dispute record and its common relationships",
"operationId": "verbose",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": false,
"type": "string"
}
]
}
},
"/Disputes/{id}/evidence": {
"post": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Dispute"
}
}
},
"description": "",
"tags": [
"Disputes"
],
"summary": "Update an existing dispute with evidence",
"operationId": "evidence",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": false,
"type": "string"
},
{
"in": "body",
"name": "evidence",
"required": false,
"schema": {
"$ref": "#/definitions/Evidence"
}
}
]
}
},
"/Disputes/{id}/close": {
"post": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Dispute"
}
}
},
"description": "",
"tags": [
"Disputes"
],
"summary": "Close an existing dispute",
"operationId": "close",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": false,
"type": "string"
}
]
}
},
"/Events/{id}": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Event"
}
}
},
"description": "",
"tags": [
"Events"
],
"summary": "Find a model instance by id from the data source.",
"operationId": "findById",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "path",
"description": "Model id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
},
{
"in": "query",
"description": "Filter defining fields and include",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/definitions/object"
}
}
]
}
},
"/Payments/{id}/disputes": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"type": "array",
"items": {
"type": "Dispute"
}
}
}
},
"description": "",
"tags": [
"Payments"
],
"summary": "Queries disputes of Payment.",
"operationId": "prototype.__get__disputes",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/definitions/object"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
}
},
"/Payments/{id}/refunds": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"type": "array",
"items": {
"type": "Refund"
}
}
}
},
"description": "",
"tags": [
"Payments"
],
"summary": "Queries refunds of Payment.",
"operationId": "prototype.__get__refunds",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/definitions/object"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
},
"post": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Refund"
}
}
},
"description": "",
"tags": [
"Payments"
],
"summary": "Create a refund for a payment.",
"operationId": "refundPayment",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": false,
"type": "string"
},
{
"in": "body",
"name": "refund",
"required": false,
"schema": {
"$ref": "#/definitions/Refund"
}
}
]
}
},
"/Payments/{id}": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Payment"
}
}
},
"description": "",
"tags": [
"Payments"
],
"summary": "Find a model instance by id from the data source.",
"operationId": "findById",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "path",
"description": "Model id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
},
{
"in": "query",
"description": "Filter defining fields and include",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/definitions/object"
}
}
]
},
"put": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Payment"
}
}
},
"description": "",
"tags": [
"Payments"
],
"summary": "Update attributes for a model instance and persist it into the data source.",
"operationId": "prototype.updateAttributes",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "body",
"description": "An object of model property name/value pairs",
"name": "data",
"required": false,
"schema": {
"$ref": "#/definitions/Payment"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
}
},
"/Payments/{id}/verbose": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Payment"
}
}
},
"description": "",
"tags": [
"Payments"
],
"summary": "Get a payment record and its common relationships",
"operationId": "verbose",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": false,
"type": "string"
}
]
}
},
"/Refunds/{id}": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Refund"
}
}
},
"description": "",
"tags": [
"Refunds"
],
"summary": "Find a model instance by id from the data source.",
"operationId": "findById",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "path",
"description": "Model id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
},
{
"in": "query",
"description": "Filter defining fields and include",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/definitions/object"
}
}
]
},
"put": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Refund"
}
}
},
"description": "",
"tags": [
"Refunds"
],
"summary": "Update attributes for a model instance and persist it into the data source.",
"operationId": "prototype.updateAttributes",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "body",
"description": "An object of model property name/value pairs",
"name": "data",
"required": false,
"schema": {
"$ref": "#/definitions/Refund"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
}
},
"/Refunds/{id}/verbose": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Refund"
}
}
},
"description": "",
"tags": [
"Refunds"
],
"summary": "Get a refund record and its common relationships",
"operationId": "verbose",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": false,
"type": "string"
}
]
}
},
"/Tokens": {
"post": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Token"
}
}
},
"description": "",
"tags": [
"Tokens"
],
"summary": "Create a new instance of the model and persist it into the data source.",
"operationId": "create",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "body",
"description": "Model instance data",
"name": "data",
"required": false,
"schema": {
"$ref": "#/definitions/Token"
}
}
]
}
},
"/Tokens/{id}": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Token"
}
}
},
"description": "",
"tags": [
"Tokens"
],
"summary": "Find a model instance by id from the data source.",
"operationId": "findById",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "path",
"description": "Model id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
},
{
"in": "query",
"description": "Filter defining fields and include",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/definitions/object"
}
}
]
},
"post": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Token"
}
}
},
"description": "",
"tags": [
"Tokens"
],
"summary": "Late capture a card token.",
"operationId": "lateCapture",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": false,
"type": "string"
}
]
}
},
"/Users": {
"post": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/User"
}
}
},
"description": "",
"tags": [
"Users"
],
"summary": "Create a new instance of the model and persist it into the data source.",
"operationId": "create",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "body",
"description": "Model instance data",
"name": "data",
"required": false,
"schema": {
"$ref": "#/definitions/User"
}
}
]
}
},
"/Users/{id}": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/User"
}
}
},
"description": "",
"tags": [
"Users"
],
"summary": "Find a model instance by id from the data source.",
"operationId": "findById",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "path",
"description": "Model id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
},
{
"in": "query",
"description": "Filter defining fields and include",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/definitions/object"
}
}
]
},
"put": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/User"
}
}
},
"description": "",
"tags": [
"Users"
],
"summary": "Update attributes for a model instance and persist it into the data source.",
"operationId": "prototype.updateAttributes",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "body",
"description": "An object of model property name/value pairs",
"name": "data",
"required": false,
"schema": {
"$ref": "#/definitions/User"
}
},
{
"in": "path",
"description": "User id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
}
},
"/Users/login": {
"post": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/object"
}
}
},
"description": "",
"tags": [
"Users"
],
"summary": "Login a user with username/email and password.",
"operationId": "login",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "body",
"name": "credentials",
"required": true,
"schema": {
"$ref": "#/definitions/object"
}
},
{
"in": "query",
"description": "Related objects to include in the response. See the description of return value for more details.",
"name": "include",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"/Users/logout": {
"post": {
"responses": {
"200": {
"description": "No response was specified"
},
"204": {
"description": "Request was successful"
}
},
"description": "",
"tags": [
"Users"
],
"summary": "Logout a user with access token",
"operationId": "logout",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
]
}
},
"/Users/{id}/customers": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Customer"
}
}
},
"description": "",
"tags": [
"Users"
],
"summary": "List customers that a user has access to",
"operationId": "customers",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": false,
"type": "string"
}
]
}
},
"/Withdrawals/{id}": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Withdrawal"
}
}
},
"description": "",
"tags": [
"Withdrawals"
],
"summary": "Find a model instance by id from the data source.",
"operationId": "findById",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "path",
"description": "Model id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
},
{
"in": "query",
"description": "Filter defining fields and include",
"name": "filter",
"required": false,
"schema": {
"$ref": "#/definitions/object"
}
}
]
},
"put": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Withdrawal"
}
}
},
"description": "",
"tags": [
"Withdrawals"
],
"summary": "Update attributes for a model instance and persist it into the data source.",
"operationId": "prototype.updateAttributes",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "body",
"description": "An object of model property name/value pairs",
"name": "data",
"required": false,
"schema": {
"$ref": "#/definitions/Withdrawal"
}
},
{
"in": "path",
"description": "Base id",
"name": "id",
"required": true,
"schema": {
"$ref": "#/definitions/any"
}
}
]
}
},
"/Withdrawals/{id}/verbose": {
"get": {
"responses": {
"200": {
"description": "Request was successful",
"schema": {
"$ref": "#/definitions/Withdrawal"
}
}
},
"description": "",
"tags": [
"Withdrawals"
],
"summary": "Get a withdrawal record and its common relationships",
"operationId": "verbose",
"produces": [
"application/json",
"application/xml",
"text/xml",
"application/javascript",
"text/javascript"
],
"consumes": [
"application/json",
"application/x-www-form-urlencoded",
"application/xml",
"text/xml"
],
"parameters": [
{
"in": "path",
"name": "id",
"required": false,
"type": "string"
}
]
}
}
},
"tags": [
{
"name": "Applications"
},
{
"name": "Users"
},
{
"name": "Banks"
},
{
"name": "Cards"
},
{
"name": "Customers"
},
{
"name": "Disputes"
},
{
"name": "Events"
},
{
"name": "Payments"
},
{
"name": "Refunds"
},
{
"name": "Tokens"
},
{
"name": "Withdrawals"
},
{
"name": "BankDrops"
},
{
"name": "BankLogins"
},
{
"name": "BankAccounts"
}
],
"host": "localhost:3000",
"basePath": "/api/v3",
"schemes": [
"http"
],
"definitions": {
"Application": {
"properties": {
"id": {
"type": "string"
},
"realm": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string",
"description": "The icon image url"
},
"owner": {
"type": "string",
"description": "The user id of the developer who registers the application"
},
"collaborators": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of users ids who have permissions to work on this app"
},
"email": {
"type": "string"
},
"emailVerified": {
"type": "boolean"
},
"url": {
"type": "string",
"description": "The application URL for OAuth 2.0"
},
"callbackUrls": {
"type": "array",
"items": {
"type": "string"
},
"description": "OAuth 2.0 code/token callback URLs"
},
"permissions": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of permissions required by the application"
},
"clientKey": {
"type": "string"
},
"javaScriptKey": {
"type": "string"
},
"restApiKey": {
"type": "string"
},
"windowsKey": {
"type": "string"
},
"masterKey": {
"type": "string"
},
"pushSettings": {
"$ref": "#/definitions/AnonymousModel_0"
},
"authenticationEnabled": {
"type": "boolean",
"default": true
},
"anonymousAllowed": {
"type": "boolean",
"default": true
},
"authenticationSchemes": {
"type": "array",
"items": {
"type": "AnonymousModel_5"
}
},
"status": {
"type": "string",
"description": "Status of the application, production/sandbox/disabled",
"default": "sandbox"
},
"created": {
"type": "string",
"format": "date"
},
"modified": {
"type": "string",
"format": "date"
}
},
"required": [
"id",
"name"
]
},
"AnonymousModel_0": {
"properties": {
"apns": {
"$ref": "#/definitions/AnonymousModel_1"
},
"gcm": {
"$ref": "#/definitions/AnonymousModel_4"
}
},
"required": []
},
"AnonymousModel_1": {
"properties": {
"production": {
"type": "boolean",
"description": "Production or development mode. It denotes what default APNS\nservers to be used to send notifications.\nSee API documentation for more details."
},
"certData": {
"type": "string",
"description": "The certificate data loaded from the cert.pem file"
},
"keyData": {
"type": "string",
"description": "The key data loaded from the key.pem file"
},
"pushOptions": {
"$ref": "#/definitions/AnonymousModel_2"
},
"feedbackOptions": {
"$ref": "#/definitions/AnonymousModel_3"
}
},
"required": []
},
"AnonymousModel_2": {
"properties": {
"gateway": {
"type": "string"
},
"port": {
"type": "number",
"format": "double"
}
},
"required": []
},
"AnonymousModel_3": {
"properties": {
"gateway": {
"type": "string"
},
"port": {
"type": "number",
"format": "double"
},
"batchFeedback": {
"type": "boolean"
},
"interval": {
"type": "number",
"format": "double"
}
},
"required": []
},
"AnonymousModel_4": {
"properties": {
"serverApiKey": {
"type": "string"
}
},
"required": []
},
"AnonymousModel_5": {
"properties": {
"scheme": {
"type": "string",
"description": "See the API docs for the list of supported values."
},
"credential": {
"$ref": "#/definitions/object"
}
},
"required": []
},
"BankAccount": {
"properties": {
"provider": {
"length": 64,
"type": "string",
"description": "The provider who's service we used"
},
"accountNumber": {
"length": 32,
"type": "string",
"description": "The account number for the bank account"
},
"routingNumber": {
"length": 32,
"type": "string",
"description": "The account number for the bank account"
},
"fingerprint": {
"length": 256,
"type": "string",
"description": "The accountNumber|routingNumber hash"
},
"availableBalance": {
"length": 32,
"type": "string",
"description": "The available balance of this account"
},
"currentBalance": {
"length": 32,
"type": "string",
"description": "The current balance of this account"
},
"bank": {
"length": 32,
"type": "string",
"description": "The name of institution"
},
"subtype": {
"length": 32,
"type": "string",
"description": "The subtype of account (checking, saving, etc)"
},
"type": {
"length": 32,
"type": "string",
"description": "The type of account (depository, etc)"
},
"meta": {
"$ref": "#/definitions/object"
},
"id": {
"length": 40,
"type": "string"
},
"loginsId": {
"type": "string"
},
"bankAccountId": {
"type": "string"
},
"bankLoginId": {
"type": "string"
}
},
"required": [
"id"
]
},
"Token": {
"properties": {
"disabled": {
"type": "boolean",
"description": "True if the token is disabled"
},
"used": {
"type": "number",
"format": "double",
"description": "The number of times the token has been used"
},
"fundType": {
"type": "string"
},
"dateVerified": {
"type": "string",
"format": "date",
"description": "The date the token was verified"
},
"verified": {
"type": "boolean",
"description": "Has the account been verified"
},
"id": {
"length": 40,
"type": "string"
},
"currentDropId": {
"type": "string"
},
"verifiedDropId": {
"type": "string"
},
"bankAccountId": {
"type": "string"
}
},
"required": [
"id"
]
},
"Customer": {
"properties": {
"birthDate": {
"type": "string",
"format": "date",
"description": "The date the customer was born or incorporated"
},
"entityType": {
"type": "string",
"description": "The entity type of the customer. Either 'isp for Individual/Sole Proprietor or 'llc' for any type of corporation."
},
"name": {
"type": "string",
"description": "The name of the customer"
},
"email": {
"type": "string",
"description": "The email of the customer"
},
"street1": {
"type": "string",
"description": "The billing descriptor"
},
"street2": {
"type": "string",
"description": "The billing descriptor"
},
"postalCode": {
"type": "string",
"description": "The billing descriptor"
},
"city": {
"type": "string",
"description": "The billing descriptor"
},
"state": {
"type": "string",
"description": "The billing descriptor"
},
"country": {
"type": "string",
"description": "The billing descriptor"
},
"phone": {
"type": "string",
"description": "The billing phone"
},
"publicKey": {
"type": "string",
"description": "The api public key for the customer"
},
"sendWebhookNotifications": {
"type": "boolean",
"description": "Whether notifications should be sent to the webhookUrl"
},
"taxId": {
"type": "string",
"description": "The tax id (EIN or SSN) of the customer"
},
"webhookUrl": {
"type": "string",
"description": "The webhook url for the customer"
},
"websiteUrl": {
"type": "string",
"description": "The website url for the customer"
},
"withdrawalsEnabled": {
"type": "boolean",
"description": "Withdrawals enabled"
},
"acceptsPayments": {
"type": "boolean",
"description": "Accept Payments"
},
"isUnderwritten": {
"type": "boolean",
"description": "Has the customer been underwritten"
},
"defaultProvider": {
"length": 32,
"type": "string",
"description": "The default provider for the customer"
},
"status": {
"length": 32,
"type": "string",
"description": "The status of the customer"
},
"internalStatus": {
"length": 32,
"type": "string",
"description": "The internal status of the customer"
},
"id": {
"length": 40,
"type": "string"
},
"bankId": {
"type": "string"
},
"addressId": {
"type": "string"
},
"contactId": {
"type": "string"
},
"legalEntityId": {
"type": "string"
},
"merchantId": {
"type": "string"
}
},
"required": [
"id"
]
},
"Authorization": {
"properties": {
"amount": {
"type": "string",
"description": "The amount to authorize"
},
"captureAmount": {
"type": "string",
"description": "The amount to be captured"
},
"captured": {
"type": "string",
"format": "date",
"description": "The date the authorization was captured"
},
"currency": {
"type": "string",
"description": "The currency of the amount to authorize"
},
"description": {
"type": "string",
"description": "A description of the authorization"
},
"expires": {
"type": "string",
"format": "date",
"description": "The date the authorization expires"
},
"failed": {
"type": "string",
"format": "date",
"description": "The date that the authorization failed"
},
"failedReason": {
"type": "string",
"description": "Reason for the potentially failed authorization attempt"
},
"meta": {
"$ref": "#/definitions/object"
},
"status": {
"type": "string",
"description": "The status of the authorization"
},
"voided": {
"type": "string",
"format": "date",
"description": "The date the authorization was voided"
},
"id": {
"length": 40,
"type": "string"
}
},
"required": [
"amount",
"id"
]
},
"Payment": {
"properties": {
"amount": {
"type": "string",
"description": "The amount of the payment"
},
"amountValue": {
"type": "number",
"format": "double",
"description": "The amount of the payment (as a bigint)"
},
"currency": {
"type": "string",
"description": "The currency for the payment"
},
"applicationFee": {
"length": 16,
"type": "string",
"description": "The application fee for the payment"
},
"applicationFeeValue": {
"type": "number",
"format": "double",
"description": "The application fee payment in cents (as a bigint)"
},
"description": {
"type": "string",
"description": "A description for the payment"
},
"disputedAmount": {
"type": "string",
"description": "The amount disputed"
},
"disputedAmountValue": {
"type": "number",
"format": "double",
"description": "The amount disputed (as a bigint)"
},
"meta": {
"$ref": "#/definitions/object"
},
"paid": {
"type": "string",
"format": "date",
"description": "The date the payment was paid"
},
"refundedAmount": {
"type": "string",
"description": "The amount refunded"
},
"refundedAmountValue": {
"type": "number",
"format": "double",
"description": "The amount refunded (as a bigint)"
},
"status": {
"type": "string",
"description": "The status of the payment"
},
"reason": {
"type": "string",
"description": "The reason for the status"
},
"postalCode": {
"type": "string"
},
"provider": {
"length": 16,
"type": "string",
"description": "The provider used to process the payment"
},
"service": {
"length": 16,
"type": "string",
"description": "The service used to process the payment"
},
"network": {
"length": 16,
"type": "string",
"description": "The network used to process the payment"
},
"id": {
"length": 40,
"type": "string"
},
"payerId": {
"type": "string"
},
"receiverId": {
"type": "string"
},
"sourceId": {
"type": "string"
},
"sourceType": {
"type": "string"
},
"tokenId": {
"type": "string"
}
},
"required": [
"amount",
"currency",
"id"
]
},
"Dispute": {
"properties": {
"amount": {
"type": "string",
"description": "The amount of the dispute"
},
"currency": {
"type": "string"
},
"description": {
"type": "string",
"description": "A short description as to the reason for the dispute"
},
"meta": {
"$ref": "#/definitions/object"
},
"status": {
"type": "string",
"description": "Status"
},
"id": {
"length": 40,
"type": "string"
},
"payerId": {
"type": "string"
},
"receiverId": {
"type": "string"
},
"sourceId": {
"type": "string"
},
"sourceType": {
"type": "string"
},
"customerId": {
"type": "string"
},
"paymentId": {
"type": "string"
},
"tokenId": {
"type": "string"
}
},
"required": [
"amount",
"id"
]
},
"Refund": {
"properties": {
"amount": {
"type": "string",
"description": "The amount of the refund"
},
"amountValue": {
"type": "number",
"format": "double",
"description": "The amount of the refund (as a bigint)"
},
"currency": {
"type": "string"
},
"description": {
"type": "string",
"description": "A short description as to the reason for the refund"
},
"refunded": {
"type": "string",
"format": "date",
"description": "The date the refund was refunded"
},
"meta": {
"$ref": "#/definitions/object"
},
"status": {
"type": "string",
"description": "Status"
},
"id": {
"length": 40,
"type": "string"
},
"payerId": {
"type": "string"
},
"receiverId": {
"type": "string"
},
"paymentId": {
"type": "string"
},
"sourceId": {
"type": "string"
},
"sourceType": {
"type": "string"
},
"customerId": {
"type": "string"
},
"tokenId": {
"type": "string"
}
},
"required": [
"amount",
"id"
]
},
"RefundStripe": {
"properties": {
"type": {
"length": 16,
"type": "string",
"description": "The payment type"
},
"object": {
"length": 16,
"type": "string",
"description": "The payment type"
},
"stripeId": {
"type": "string",
"description": "The stripe id for this object"
},
"chargeId": {
"type": "string",
"description": "The id of the charge that was refunded"
},
"reason": {
"type": "string",
"description": "Reason for this refund"
},
"receiptNumber": {
"type": "string",
"description": "Reason for this refund"
},
"refundId": {
"length": 64,
"type": "string",
"description": "The relational payment id"
},
"id": {
"length": 40,
"type": "string"
}
},
"required": [
"id"
]
},
"RefundVantiv": {
"properties": {
"tokenId": {
"length": 64,
"type": "string"
},
"txnId": {
"length": 64,
"type": "string"
},
"orderId": {
"length": 64,
"type": "string"
},
"statusCode": {
"length": 64,
"type": "string"
},
"status": {
"length": 64,
"type": "string"
},
"authCode": {
"length": 64,
"type": "string"
},
"responseTime": {
"length": 64,
"type": "string"
},
"postDate": {
"length": 64,
"type": "string"
},
"tokenCode": {
"length": 64,
"type": "string"
},
"tokenMessage": {
"length": 64,
"type": "string"
},
"tokenType": {
"length": 64,
"type": "string"
},
"tokenBin": {
"length": 64,
"type": "string"
},
"intl": {
"length": 64,
"type": "string"
},
"responseCode": {
"length": 64,
"type": "string"
},
"responseMessage": {
"length": 64,
"type": "string"
},
"fraudAvsCode": {
"length": 64,
"type": "string"
},
"fraudCardValidationCode": {
"length": 64,
"type": "string"
},
"fraudCardValidationMessage": {
"length": 64,
"type": "string"
},
"reportGroup": {
"length": 64,
"type": "string"
},
"customerId": {
"length": 64,
"type": "string"
},
"id": {
"length": 40,
"type": "string"
},
"refundId": {
"type": "string"
}
},
"required": [
"id"
]
},
"Response": {
"properties": {
"provider": {
"length": 32,
"type": "string",
"description": "The name of the provider"
},
"resource": {
"length": 32,
"type": "string",
"description": "The name of the resource"
},
"resourceKey": {
"length": 256,
"type": "string",
"description": "The resource key or type"
},
"resourceId": {
"length": 32,
"type": "string",
"description": "The id for that resource (not provider specific)"
},
"response": {
"$ref": "#/definitions/object"
},
"id": {
"length": 40,
"type": "string"
},
"linkType": {
"type": "string"
},
"linkId": {
"type": "string"
},
"responderType": {
"type": "string"
},
"responderId": {
"type": "string"
}
},
"required": [
"id"
]
},
"PaymentStripe": {
"properties": {
"type": {
"length": 16,
"type": "string",
"description": "The payment type"
},
"object": {
"length": 16,
"type": "string",
"description": "The payment type"
},
"stripeId": {
"type": "string",
"description": "The stripe id for this object"
},
"sourceId": {
"type": "string",
"description": "The source id of the payment"
},
"sourceObject": {
"type": "string",
"description": "The source object for that id"
},
"captured": {
"type": "boolean",
"description": "Whether this payment has been captured"
},
"fundId": {
"length": 64,
"type": "string",
"description": "The relational payment id"
},
"id": {
"length": 40,
"type": "string"
},
"paymentId": {
"type": "string"
}
},
"required": [
"sourceId",
"sourceObject",
"id"
]
},
"PaymentVantiv": {
"properties": {
"tokenId": {
"length": 64,
"type": "string"
},
"txnId": {
"length": 64,
"type": "string"
},
"orderId": {
"length": 64,
"type": "string"
},
"statusCode": {
"length": 64,
"type": "string"
},
"status": {
"length": 64,
"type": "string"
},
"authCode": {
"length": 64,
"type": "string"
},
"responseTime": {
"length": 64,
"type": "string"
},
"postDate": {
"length": 64,
"type": "string"
},
"tokenCode": {
"length": 64,
"type": "string"
},
"tokenMessage": {
"length": 64,
"type": "string"
},
"tokenType": {
"length": 64,
"type": "string"
},
"tokenBin": {
"length": 64,
"type": "string"
},
"intl": {
"length": 64,
"type": "string"
},
"responseCode": {
"length": 64,
"type": "string"
},
"responseMessage": {
"length": 64,
"type": "string"
},
"fraudAvsCode": {
"length": 64,
"type": "string"
},
"fraudCardValidationCode": {
"length": 64,
"type": "string"
},
"fraudCardValidationMessage": {
"length": 64,
"type": "string"
},
"reportGroup": {
"length": 64,
"type": "string"
},
"customerId": {
"length": 64,
"type": "string"
},
"id": {
"length": 40,
"type": "string"
},
"paymentId": {
"type": "string"
}
},
"required": [
"id"
]
},
"Bank": {
"properties": {
"accountNumber": {
"type": "string",
"description": "The account number for the bank account"
},
"accountType": {
"type": "string",
"description": "The type of account (checking, savings)"
},
"bankName": {
"type": "string",
"description": "The name of the bank associated with the bank account"
},
"canCredit": {
"type": "boolean",
"description": "True if the bank account can be credited"
},
"canDebit": {
"type": "boolean",
"description": "True if the bank account can be debited"
},
"currency": {
"type": "string",
"description": "The currency for the bank account"
},
"disabled": {
"type": "boolean",
"description": "True if the card is disabled"
},
"last4": {
"type": "string",
"description": "The last 4 digits of the account number"
},
"nameOnAccount": {
"type": "string",
"description": "The full name on the bank account"
},
"nickname": {
"type": "string",
"description": "A descriptive name for the bank account"
},
"routingNumber": {
"type": "string",
"description": "The routing number for the bank account"
},
"dropAmount1": {
"type": "string",
"description": "The first verification amount."
},
"dropAmount2": {
"type": "string",
"description": "The second verification amount."
},
"verified": {
"type": "boolean",
"description": "Has the bank account been verified."
},
"verificationMethod": {
"type": "string",
"description": "The method used to verify the bank account"
},
"status": {
"length": 32,
"type": "string",
"description": "The status of the bank account"
},
"internalStatus": {
"length": 32,
"type": "string",
"description": "The internal status of the bank account"
},
"id": {
"length": 40,
"type": "string"
},
"ownerId": {
"type": "string"
},
"street1": {
"length": 128,
"type": "string",
"description": "The street address"
},
"street2": {
"length": 128,
"type": "string",
"description": "Extra street address details"
},
"city": {
"length": 64,
"type": "string",
"description": "The city for the address"
},
"state": {
"length": 4,
"type": "string",
"description": "The state for the address"
},
"postalCode": {
"length": 16,
"type": "string",
"description": "The postal code for the address"
},
"country": {
"length": 4,
"type": "string",
"description": "The country for the address"
}
},
"required": [
"id"
]
},
"BankStripe": {
"properties": {
"stripeTokenId": {
"length": 64,
"type": "string",
"description": "The token id for the stripe bank"
},
"stripeBankId": {
"length": 64,
"type": "string",
"description": "The stripe bank id for the token"
},
"stripeAccountId": {
"length": 64,
"type": "string",
"description": "The stripe account associated with the bank account"
},
"stripeStatus": {
"length": 64,
"type": "string",
"description": "The status of the bank account"
},
"country": {
"length": 4,
"type": "string",
"description": "The country for the bank account"
},
"fingerprint": {
"length": 64,
"type": "string",
"description": "The bank fingerprint"
},
"stripeTokenUsed": {
"type": "boolean",
"description": "Has the stripe token been used"
},
"currency": {
"length": 24,
"type": "string",
"description": "The currency for the bank account"
},
"routingNumber": {
"length": 24,
"type": "string",
"description": "The routingNumber for the bank account"
},
"bankName": {
"length": 24,
"type": "string",
"description": "The bank name for the bank account"
},
"defaultForCurrency": {
"type": "boolean",
"description": "Is this account the default for the currency"
},
"metadata": {
"$ref": "#/definitions/object"
},
"last4": {
"length": 4,
"type": "string",
"description": "The last4 of the account number"
},
"verified": {
"type": "boolean",
"description": "Has the account been drop verified"
},
"dateVerified": {
"type": "string",
"format": "date",
"description": "The date the token was drop verified"
},
"dateLastDropped": {
"type": "string",
"format": "date",
"description": "The date last drop was initiated"
},
"id": {
"length": 40,
"type": "string"
},
"fundId": {
"type": "string"
}
},
"required": [
"id"
]
},
"Verification": {
"properties": {
"fundId": {
"type": "string"
},
"id": {
"length": 40,
"type": "string"
},
"bankId": {
"type": "string"
},
"customerId": {
"type": "string"
}
},
"required": [
"id"
]
},
"Withdrawal": {
"properties": {
"amount": {
"type": "string",
"description": "The amount for the withdrawal"
},
"amountValue": {
"type": "number",
"format": "double"
},
"currency": {
"type": "string"
},
"description": {
"type": "string",
"description": "A description for the withdrawal"
},
"meta": {
"$ref": "#/definitions/object"
},
"status": {
"type": "string",
"description": "The status for the withdrawal"
},
"reason": {
"type": "string",
"description": "The reason for the withdrawal status"
},
"expectedSettlementDate": {
"type": "string",
"format": "date",
"description": "The expected settlement date"
},
"settlementDate": {
"type": "string",
"format": "date",
"description": "The date the payment was settled."
},
"provider": {
"length": 16,
"type": "string",
"description": "The provider used to process the settlement"
},
"service": {
"length": 16,
"type": "string",
"description": "The service used to process the settlement"
},
"network": {
"length": 16,
"type": "string",
"description": "The network used to process the settlement"
},
"id": {
"length": 40,
"type": "string"
},
"customerId": {
"type": "string"
},
"tokenId": {
"type": "string"
},
"sourceId": {
"type": "string"
},
"sourceType": {
"type": "string"
}
},
"required": [
"amount",
"id"
]
},
"WithdrawalStripe": {
"properties": {
"id": {
"type": "string",
"description": "The stripe id for this object"
},
"object": {
"length": 16,
"type": "string",
"description": "The withdrawal object (transfer)"
},
"amount": {
"type": "string",
"description": "The amount transferred in cents"
},
"amount_reversed": {
"type": "string",
"description": "The amount reversed in cents"
},
"status": {
"type": "string",
"description": "The current status of the transfer"
},
"currency": {
"length": 3,
"type": "string",
"description": "The currency for this transfer"
},
"date": {
"type": "string",
"format": "date",
"description": "Date the transfer is scheduled to arrive in the bank. This doesn’t factor in delays like weekends or bank holidays."
},
"metadata": {
"type": "string",
"description": "metadata"
},
"reversals": {
"length": 64,
"type": "string",
"description": "The relational withdrawal id"
},
"type": {
"length": 20,
"type": "string",
"description": "The withdrawal type (card, bank_account, or stripe_account"
},
"destination": {
"length": 50,
"type": "string",
"description": "The id of account transfer was sent to"
},
"destinationPayment": {
"length": 50,
"type": "string",
"description": "If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer"
},
"failureCode": {
"type": "string",
"description": "Error code if transfer failed"
},
"failureMessage": {
"type": "string",
"description": "Error message if transfer failed"
},
"sourceTransaction": {
"type": "string",
"description": "Id of charge used to fund transfer. Null if transfered from available balance."
},
"statementDescriptor": {
"type": "string",
"description": "Extra information displayed on user's bank statement"
},
"withdrawalId": {
"length": 64,
"type": "string",
"description": "The relational withdrawal id"
}
},
"required": []
},
"BankDrop": {
"properties": {
"dropDate": {
"type": "string",
"format": "date",
"description": "The date the amounts were dropped"
},
"dropped": {
"type": "boolean",
"description": "Was the amount dropped"
},
"verifiedDate": {
"type": "string",
"format": "date",
"description": "The date the drops were verified"
},
"verified": {
"type": "boolean",
"description": "Were the drops verified"
},
"failed": {
"type": "boolean",
"description": "Did the drop fail"
},
"failedReason": {
"length": 64,
"type": "string",
"description": "The reason the drop failed"
},
"provider": {
"length": 64,
"type": "string",
"description": "The provider used for the drop"
},
"id": {
"length": 40,
"type": "string"
},
"tokenId": {
"type": "string"
},
"bankId": {
"type": "string"
}
},
"required": [
"id"
]
},
"Card": {
"properties": {
"brand": {
"type": "string",
"description": "The type of Card (Visa, American Express, etc)"
},
"canCredit": {
"type": "boolean",
"description": "True if the card can be credited"
},
"canDebit": {
"type": "boolean",
"description": "True if the card can be debited"
},
"disabled": {
"type": "boolean",
"description": "True if the card is disabled"
},
"expirationMonth": {
"type": "number",
"format": "double",
"description": "The expiration month for the card"
},
"expirationYear": {
"type": "number",
"format": "double",
"description": "The expiration year for the card"
},
"last4": {
"type": "string",
"description": "The last4 digits of the card number"
},
"nameOnCard": {
"type": "string",
"description": "The full name on the card"
},
"nickname": {
"type": "string",
"description": "A descriptive name for the card"
},
"verified": {
"type": "string",
"format": "date",
"description": "The date the card was verified"
},
"street1": {
"length": 128,
"type": "string",
"description": "The street address"
},
"street2": {
"length": 128,
"type": "string",
"description": "Extra street address details"
},
"city": {
"length": 64,
"type": "string",
"description": "The city for the address"
},
"state": {
"length": 4,
"type": "string",
"description": "The state for the address"
},
"postalCode": {
"length": 16,
"type": "string",
"description": "The postal code for the address"
},
"country": {
"length": 4,
"type": "string",
"description": "The country for the address"
}
},
"required": []
},
"CardStripe": {
"properties": {
"tokenId": {
"length": 64,
"type": "string",
"description": "The token id for the stripe"
},
"cardId": {
"length": 64,
"type": "string",
"description": "The stripe card id for the token"
},
"customerId": {
"length": 64,
"type": "string",
"description": "The stripe customer id for the token"
},
"cvcCheck": {
"length": 16,
"type": "string",
"description": "CVC check from stripe"
},
"streetCheck": {
"length": 16,
"type": "string",
"description": "Street check from stripe"
},
"postalCodeCheck": {
"length": 16,
"type": "string",
"description": "Postal check from stripe"
},
"tokenizationMethod": {
"length": 16,
"type": "string",
"description": "The tokenization method (apply_pay etc)"
},
"dynamicLast4": {
"length": 4,
"type": "string",
"description": "The last4 of the numbers"
},
"fingerprint": {
"length": 64,
"type": "string",
"description": "The card fingerprint"
},
"currency": {
"length": 3,
"type": "string",
"description": "The currency for the card"
},
"metadata": {
"$ref": "#/definitions/object"
},
"funding": {
"length": 16,
"type": "string",
"description": "The type of funding"
},
"brand": {
"length": 16,
"type": "string",
"description": "The card brand"
},
"id": {
"length": 40,
"type": "string"
},
"fundId": {
"type": "string"
}
},
"required": [
"id"
]
},
"CardVantiv": {
"properties": {
"tokenId": {
"length": 64,
"type": "string"
},
"txnId": {
"length": 64,
"type": "string"
},
"orderId": {
"length": 64,
"type": "string"
},
"statusCode": {
"length": 64,
"type": "string"
},
"status": {
"length": 64,
"type": "string"
},
"authCode": {
"length": 64,
"type": "string"
},
"responseTime": {
"length": 64,
"type": "string"
},
"postDate": {
"length": 64,
"type": "string"
},
"tokenCode": {
"length": 64,
"type": "string"
},
"tokenMessage": {
"length": 64,
"type": "string"
},
"tokenType": {
"length": 64,
"type": "string"
},
"tokenBin": {
"length": 64,
"type": "string"
},
"intl": {
"length": 64,
"type": "string"
},
"responseCode": {
"length": 64,
"type": "string"
},
"responseMessage": {
"length": 64,
"type": "string"
},
"fraudAvsCode": {
"length": 64,
"type": "string"
},
"fraudCardValidationCode": {
"length": 64,
"type": "string"
},
"fraudCardValidationMessage": {
"length": 64,
"type": "string"
},
"reportGroup": {
"length": 64,
"type": "string"
},
"customerId": {
"length": 64,
"type": "string"
},
"id": {
"length": 40,
"type": "string"
},
"fundId": {
"type": "string"
},
"cardId": {
"type": "string"
}
},
"required": [
"id"
]
},
"User": {
"properties": {
"realm": {
"type": "string"
},
"username": {
"type": "string"
},
"credentials": {
"$ref": "#/definitions/object"
},
"challenges": {
"$ref": "#/definitions/object"
},
"email": {
"type": "string"
},
"emailVerified": {
"type": "boolean"
},
"verificationToken": {
"type": "string"
},
"status": {
"type": "string"
},
"created": {
"type": "string",
"format": "date"
},
"lastUpdated": {
"type": "string",
"format": "date"
},
"id": {
"type": "number",
"format": "double"
},
"firstName": {
"length": 64,
"type": "string",
"description": "The first name for the contact"
},
"lastName": {
"length": 64,
"type": "string",
"description": "The last name for the contact"
},
"phone": {
"length": 16,
"type": "string",
"description": "The primary phone number for the contact"
},
"dateOfBirth": {
"type": "string",
"format": "date",
"description": "The date of birth for the contact"
},
"ipAddress": {
"type": "string",
"description": "The ip address the record was created from"
}
},
"required": [
"email"
]
},
"AccessToken": {
"properties": {
"id": {
"type": "string"
},
"ttl": {
"type": "number",
"format": "double",
"description": "time to live in seconds (2 weeks by default)",
"default": 1209600
},
"created": {
"type": "string",
"format": "date"
},
"userId": {
"type": "number",
"format": "double"
}
},
"required": [
"id"
]
},
"CustomerUser": {
"properties": {
"id": {
"type": "number",
"format": "double"
},
"customerId": {
"type": "string"
},
"userId": {
"type": "number",
"format": "double"
}
},
"required": []
},
"Address": {
"properties": {
"street1": {
"length": 128,
"type": "string",
"description": "The street address"
},
"street2": {
"length": 128,
"type": "string",
"description": "Extra street address details"
},
"city": {
"length": 64,
"type": "string",
"description": "The city for the address"
},
"state": {
"length": 4,
"type": "string",
"description": "The state for the address"
},
"postalCode": {
"length": 16,
"type": "string",
"description": "The postal code for the address"
},
"country": {
"length": 4,
"type": "string",
"description": "The country for the address"
}
},
"required": []
},
"Contact": {
"properties": {
"firstName": {
"length": 64,
"type": "string",
"description": "The first name for the contact"
},
"lastName": {
"length": 64,
"type": "string",
"description": "The last name for the contact"
},
"email": {
"length": 128,
"type": "string",
"description": "The primary email address for the contact"
},
"phone": {
"length": 16,
"type": "string",
"description": "The primary phone number for the contact"
},
"dateOfBirth": {
"type": "string",
"format": "date",
"description": "The date of birth for the contact"
},
"id": {
"length": 40,
"type": "string"
}
},
"required": [
"id"
]
},
"Event": {
"properties": {
"data": {
"$ref": "#/definitions/object"
},
"id": {
"length": 40,
"type": "string"
},
"customerId": {
"type": "string"
}
},
"required": [
"id"
]
},
"Subscription": {
"properties": {
"status": {
"type": "string",
"description": "The current status for the subscription"
},
"price": {
"type": "string",
"description": "The price for the subscription"
},
"currency": {
"type": "string",
"description": "The currency for the price"
},
"trialStartDate": {
"type": "string",
"format": "date",
"description": "The date the subscription trial started"
},
"startDate": {
"type": "string",
"format": "date",
"description": "The date the subscription will start or did start"
},
"endedDate": {
"type": "string",
"format": "date",
"description": "The date the subscription ended"
},
"id": {
"length": 40,
"type": "string"
}
},
"required": [
"id"
]
},
"Plan": {
"properties": {
"name": {
"type": "string",
"description": "The name of the plan"
},
"group": {
"type": "string",
"description": "The group the plan is associated with the plan"
},
"level": {
"type": "string",
"description": "The feature set level associated with the plan"
},
"description": {
"type": "string",
"description": "A description of the plan"
},
"price": {
"type": "string",
"description": "The price of the plan"
},
"currency": {
"type": "string",
"description": "The currency for the price"
},
"interval": {
"type": "string",
"description": "The recurring interval for the plan"
},
"trialDays": {
"type": "number",
"format": "double",
"description": "The length of the trial period"
},
"id": {
"length": 40,
"type": "string"
}
},
"required": [
"id"
]
},
"Underwriting": {
"properties": {
"entityType": {
"type": "string",
"description": "The name to the entity to be underwritten (person or business)"
},
"name": {
"type": "string",
"description": "The name to the entity to be underwritten (person or business)"
},
"firstName": {
"type": "string",
"description": "The first name of the principle."
},
"lastName": {
"type": "string",
"description": "The last name of the principle."
},
"websiteUrl": {
"type": "string",
"description": "The website of the entity to be underwritten"
},
"taxId": {
"type": "string",
"description": "The tax id fo the entity to be underwritten"
},
"ssn": {
"type": "string",
"description": "The ssn the entity to be underwritten"
},
"status": {
"type": "string",
"description": "The current status"
},
"descriptor": {
"type": "string",
"description": "The billing descriptor"
},
"echeckDescriptor": {
"type": "string",
"description": "The billing echeck descriptor"
},
"street1": {
"type": "string",
"description": "The billing descriptor"
},
"street2": {
"type": "string",
"description": "The billing descriptor"
},
"city": {
"type": "string",
"description": "The billing descriptor"
},
"state": {
"type": "string",
"description": "The billing descriptor"
},
"postalCode": {
"type": "string",
"description": "The billing descriptor"
},
"country": {
"type": "string",
"description": "The billing descriptor"
},
"phone": {
"type": "string",
"description": "The billing phone"
},
"bankRoutingNumber": {
"type": "string",
"description": "The bank routing number"
},
"bankAccountNumber": {
"type": "string",
"description": "The bank account number"
},
"id": {
"length": 40,
"type": "string"
},
"bankId": {
"type": "string"
},
"email": {
"length": 128,
"type": "string",
"description": "The primary email address for the contact"
},
"dateOfBirth": {
"type": "string",
"format": "date",
"description": "The date of birth for the contact"
}
},
"required": [
"id"
]
},
"Wallet": {
"properties": {
"nickname": {
"type": "string",
"description": "A descriptive name for the wallet"
},
"currency": {
"type": "string",
"description": "The currency for the wallet"
},
"walletAddress": {
"type": "string",
"description": "The address for the wallet"
},
"verified": {
"type": "string",
"format": "date",
"description": "The date the wallet was verified"
},
"canCredit": {
"type": "boolean",
"description": "True if the wallet can be credited"
},
"canDebit": {
"type": "boolean",
"description": "True if the wallet can be debited"
},
"id": {
"length": 40,
"type": "string"
},
"street1": {
"length": 128,
"type": "string",
"description": "The street address"
},
"street2": {
"length": 128,
"type": "string",
"description": "Extra street address details"
},
"city": {
"length": 64,
"type": "string",
"description": "The city for the address"
},
"state": {
"length": 4,
"type": "string",
"description": "The state for the address"
},
"postalCode": {
"length": 16,
"type": "string",
"description": "The postal code for the address"
},
"country": {
"length": 4,
"type": "string",
"description": "The country for the address"
}
},
"required": [
"walletAddress",
"id"
]
},
"LegalEntity": {
"properties": {
"entityType": {
"length": 32,
"type": "string",
"description": "The type of legal entity"
},
"businessName": {
"length": 128,
"type": "string",
"description": "The name to the entity to be underwritten (person or business)"
},
"businessTaxId": {
"length": 16,
"type": "string",
"description": "The business tax id (ie EIN)"
},
"businessSalesVolume": {
"length": 16,
"type": "string",
"description": "The credit card sales volume in dollars for the business"
},
"businessAcceptedCards": {
"type": "boolean",
"description": "Has the business accepted credit cards before"
},
"personalTaxId": {
"length": 16,
"type": "string",
"description": "The tax id for the company representative (ie SSN)"
},
"last4PersonalTaxId": {
"length": 8,
"type": "string",
"description": "The last 4 digits of the tax id for the company representative"
},
"id": {
"length": 40,
"type": "string"
},
"businessAddressId": {
"type": "string"
},
"personalAddressId": {
"type": "string"
},
"personalContactId": {
"type": "string"
}
},
"required": [
"id"
]
},
"LegalEntityStripe": {
"properties": {
"accountId": {
"length": 64,
"type": "string",
"description": "The Stripe secret key for the merchant"
},
"secretKey": {
"length": 64,
"type": "string",
"description": "The Stripe secret key for the merchant"
},
"publishableKey": {
"length": 64,
"type": "string",
"description": "The Stripe publishable key for the merchant"
},
"country": {
"length": 4,
"type": "string",
"description": "The country for the legal entity"
},
"verificationStatus": {
"length": 16,
"type": "string",
"description": "The state of verification for this legal entity. Possible values are unverified, pending, or verified."
},
"verificationDocument": {
"length": 64,
"type": "string",
"description": "(ID of a file upload) A photo (jpg or png) of an identifying document, either a passport or local ID card."
},
"verificationDetails": {
"length": 128,
"type": "string",
"description": "A user-displayable string describing the verification state for this legal entity. For example, if a document is uploaded and the picture is too fuzzy, this may say 'Identity document is too unclear to read.'"
},
"managed": {
"type": "boolean",
"description": "Whether or not the account is managed by your platform. Returns null if the account was not created by a platform"
},
"id": {
"length": 40,
"type": "string"
},
"legalEntityId": {
"type": "string"
}
},
"required": [
"id"
]
},
"LegalEntityVantiv": {
"properties": {
"vantivEntityId": {
"type": "string",
"description": "The vantiv entity id"
},
"txnId": {
"type": "string",
"description": "The vantiv entity txnId"
},
"statusCode": {
"type": "string",
"description": "The vantiv entity status code"
},
"status": {
"type": "string",
"description": "The vantiv entity status"
},
"id": {
"length": 40,
"type": "string"
},
"legalEntityId": {
"type": "string"
}
},
"required": [
"id"
]
},
"Merchant": {
"properties": {
"businessName": {
"length": 128,
"type": "string",
"description": "The name to the business"
},
"businessUrl": {
"length": 128,
"type": "string",
"description": "The url for the business"
},
"businessLogo": {
"length": 128,
"type": "string",
"description": "The logo for the business"
},
"supportEmail": {
"length": 128,
"type": "string",
"description": "The support email for the business"
},
"supportPhone": {
"length": 16,
"type": "string",
"description": "The support phone for the business"
},
"supportUrl": {
"length": 128,
"type": "string",
"description": "The support url for the business"
},
"productDescription": {
"length": 256,
"type": "string",
"description": "A description of the products the business sells"
},
"statementDescriptor": {
"length": 32,
"type": "string",
"description": "The string that will be shown on customer bank statements"
},
"defaultCurrency": {
"length": 8,
"type": "string",
"description": "The default purchase currency for the business"
},
"mcc": {
"length": 8,
"type": "string",
"description": "The merchant category code for the business"
},
"amexId": {
"length": 32,
"type": "string",
"description": "The american express id for the merchant"
},
"discoverId": {
"length": 32,
"type": "string",
"description": "The discover id for the merchant"
},
"verified": {
"type": "boolean",
"description": "Is the kyc verified"
},
"status": {
"length": 32,
"type": "string",
"description": "The status of the legal entity"
},
"internalStatus": {
"length": 32,
"type": "string",
"description": "The internal status of the legal entity"
},
"id": {
"length": 40,
"type": "string"
},
"legalEntityId": {
"type": "string"
},
"businessAddressId": {
"type": "string"
},
"personalContactId": {
"type": "string"
},
"bankId": {
"type": "string"
}
},
"required": [
"id"
]
},
"MerchantStripe": {
"properties": {
"accountId": {
"length": 64,
"type": "string",
"description": "The Stripe secret key for the merchant"
},
"tosDate": {
"length": 32,
"type": "string",
"description": "The unix timestamp that Stripe's terms of service were agreed to by the account holder"
},
"tosIp": {
"length": 16,
"type": "string",
"description": "The IP address from which Stripe’s terms of service were agreed to by the account holder"
},
"tosUserAgent": {
"length": 64,
"type": "string",
"description": "The user agent of the browser from which Stripe's terms of service were agreed to by the account holder"
},
"transferDelayDays": {
"length": 16,
"type": "string",
"description": "The number of days charges for the account will be held before being paid out. May also be the string 'minimum' for the lowest available value (based on country). Default is 'minimum'. Does not apply when interval is 'manual'"
},
"transferInterval": {
"length": 16,
"type": "string",
"description": "How frequently funds will be paid out. One of manual (for only triggered via API call), daily, weekly, or monthly. Default is daily."
},
"transferMonthlyAnchor": {
"length": 16,
"type": "string",
"description": "The day of the month funds will be paid out. Required and available only if interval is monthly."
},
"transferWeeklyAnchor": {
"length": 16,
"type": "string",
"description": "The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Required and available only if interval is weekly"
},
"verificationFieldsNeeded": {
"$ref": "#/definitions/object"
},
"verificationDueBy": {
"type": "string",
"format": "date",
"description": "At what time the fields_needed must be provided. If this date is in the past, the account is already in bad standing, and providing fields_needed is necessary to re-enable transfers and prevent other consequences. If this date is in the future, fields_needed must be provided to ensure the account remains in good standing."
},
"verificationDisabledReason": {
"length": 16,
"type": "string",
"description": "A string describing the reason for this account being unable to charge and/or transfer, if that is the case. Possible values are rejected.fraud, rejected.terms_of_service, rejected.listed, rejected.other, fields_needed, listed, or other."
},
"displayName": {
"length": 64,
"type": "string",
"description": "The display name for this account. This is used on the Stripe dashboard to help you differentiate between accounts."
},
"timezone": {
"length": 128,
"type": "string",
"description": "The timezone used in the Stripe dashboard for this account. A list of possible timezone values is maintained at the IANA Timezone Database."
},
"declineChargeOnAvsFailure": {
"type": "boolean",
"description": "Whether or not Stripe should automatically decline charges with an incorrect zip/postal code. This setting only applies if a card includes a zip code and the bank specifically marks it as failed."
},
"declineChargeOnCvcFailure": {
"type": "boolean",
"description": "Whether or not Stripe should automatically decline charges with an incorrect CVC. This setting only applies if a card includes a CVC and the bank specifically marks it as failed."
},
"debitNegativeBalances": {
"type": "boolean",
"description": "Whether or not Stripe will attempt to reclaim negative account balances from this account’s bank account."
},
"detailedSubmitted": {
"type": "boolean",
"description": "Whether or not account details have been submitted yet. Standalone accounts cannot receive transfers before this is true."
},
"chargesEnabled": {
"type": "boolean",
"description": "Are charges enabled for the customer"
},
"transfersEnabled": {
"type": "boolean",
"description": "Are transfers enabled for the customer"
},
"status": {
"length": 32,
"type": "string",
"description": "The status of the stripe merchant"
},
"internalStatus": {
"length": 32,
"type": "string",
"description": "The internal status of the stripe merchant"
},
"id": {
"length": 40,
"type": "string"
},
"merchantId": {
"type": "string"
}
},
"required": [
"id"
]
},
"MerchantVantiv": {
"properties": {
"txnId": {
"type": "string",
"description": "The vantiv merchant txnId"
},
"vantivMerchantId": {
"type": "string",
"description": "The vantiv merchant id"
},
"vantivMerchantString": {
"type": "string",
"description": "The vantiv merchant string"
},
"id": {
"length": 40,
"type": "string"
},
"merchantId": {
"type": "string"
}
},
"required": [
"id"
]
},
"BankLogin": {
"properties": {
"loginDate": {
"type": "string",
"format": "date",
"description": "The date of login"
},
"status": {
"length": 32,
"type": "string",
"description": "The status of the bank account"
},
"internalStatus": {
"length": 32,
"type": "string",
"description": "The internal status of the bank account"
},
"verified": {
"type": "boolean",
"description": "Has the token been login verified"
},
"dateVerified": {
"type": "string",
"format": "date",
"description": "The date the token was verified"
},
"dateExpired": {
"type": "string",
"format": "date",
"description": "The date this token expired"
},
"id": {
"length": 40,
"type": "string"
},
"tokenId": {
"type": "string"
},
"customerId": {
"type": "string"
},
"bankUserId": {
"type": "string"
},
"loginId": {
"type": "string"
}
},
"required": [
"id"
]
},
"BankLoginPlaid": {
"properties": {
"accessToken": {
"length": 64,
"type": "string",
"description": "The plaid access token for this account"
},
"fingerprint": {
"length": 256,
"type": "string",
"description": "The user|pass|bank hash"
},
"verified": {
"type": "boolean",
"description": "Has the token been login verified"
},
"dateVerified": {
"type": "string",
"format": "date",
"description": "The date the token was verified"
},
"dateTransactionsLastPulled": {
"type": "string",
"format": "date",
"description": "The date we grabbed transactions last"
},
"dateBalanceLastPulled": {
"type": "string",
"format": "date",
"description": "The date we grabbed balance last"
},
"id": {
"length": 40,
"type": "string"
},
"bankLogin": {
"type": "string"
},
"bankId": {
"type": "string"
},
"tokenId": {
"type": "string"
}
},
"required": [
"id"
]
},
"BankTransaction": {
"properties": {
"plaidTransactionId": {
"length": 32,
"type": "string",
"description": "The plaid transaction id for this transaction"
},
"plaidAccountId": {
"length": 32,
"type": "string",
"description": "The plaid account id that this transaction is on"
},
"amount": {
"length": 32,
"type": "string",
"description": "The amount for this transaction"
},
"date": {
"type": "string",
"format": "date",
"description": "The date transaction was posted"
},
"name": {
"length": 32,
"type": "string",
"description": "The name for this transaction"
},
"pending": {
"type": "boolean",
"description": "If transaction is pending"
},
"category": {
"$ref": "#/definitions/object"
},
"categoryId": {
"length": 32,
"type": "string",
"description": "Place, Ditital, or Special"
},
"type": {
"length": 32,
"type": "string",
"description": "The category id for this transaction"
},
"pendingTransaction": {
"length": 32,
"type": "string",
"description": "The id of a posted transaction's associated pending transaction where applicable"
},
"score": {
"$ref": "#/definitions/object"
},
"meta": {
"$ref": "#/definitions/object"
},
"id": {
"length": 40,
"type": "string"
},
"tokenId": {
"type": "string"
},
"bankLoginId": {
"type": "string"
}
},
"required": [
"id"
]
},
"BankUser": {
"properties": {
"fingerprint": {
"length": 256,
"type": "string",
"description": "The user|pass|bank hash"
},
"id": {
"length": 40,
"type": "string"
}
},
"required": [
"id"
]
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment