Introduction

Welcome to the Unit API! Our documentation will walk you from the basics (authentication, request structure) to using and creating financial products (accounts, cards, payments etc.).

Unit treats each client as a standalone organization. You may log into the Unit Dashboard to manage your organization's API tokens, users, applications, customers, accounts and more.

Ready to get started? Sign up here to receive immediate access to our Sandbox and start building with Unit.

This introduction section describes the principles that you would need to be familiar with to make the best use of the Unit platform.

Environments

Our API and Dashboard are available in two environments:

Name	Dashboard URL	API URL
Sandbox	https://app.s.unit.sh/	`https://api.s.unit.sh/`
Production	Please contact Unit	Please contact Unit

The sandbox environment contains special API operations that allow you to easily test and simulate different activities, from incoming payments to card spend. You can find the full reference under Simulations.

SDKs

Unit maintains a Node.js (Typescript) SDK on Github that wraps all resources and API endpoints. We are actively working on SDKs for additional languages.

Postman Collection

You can interact immediately with the Unit API via Postman.

To get started, import the Unit API Postman Collection into Postman, either by link or by downloading and importing the file. For more information, see the following under the Postman help: Importing Data into Postman.

The collection contains two variables:

Key	Value
`token`	Your API Token. You can create it from the API Tokens page on the Unit Dashboard.
`server_url`	Initially set to the sandbox environment.

JSON Schema

You can download an archive with JSON Schemas for Unit API.

You can use one of the libraries that generate types from JSON schemas - see table below for examples of common language specific libraries.

Language	Library
NodeJS / TypeScript	[json-schema-to-typescript] (https://www.npmjs.com/package/json-schema-to-typescript)
Python	yacg (Yet Another Code Generation)
PHP	php-code-builder

Authentication

Example

GET /accounts HTTP/1.1
Host: api.s.unit.sh
Authorization: Bearer v2.public.eyJyb2xlIjoib3JnIiwidX...

Unit's API uses OAuth 2.0 Bearer Token to authenticate requests. All API calls must include a bearer token.

An invalid, missing or expired token will result in HTTP 401 Unauthorized responses.

Tokens

Unit Clients use 2 types of API tokens:

Org API tokens should be used for broad, system level API calls that are not associated with a specific customer.
Customer Tokens should be used for customer specific actions, as they only allow access to resources associated with a specific customer.

Each API token can be associated with a set of Scopes. The scopes define the resource types and access level (e.g. read / write) that will be allowed using that token.

Some actions you can make using Unit’s API are considered sensitive - as they are related to movement of funds, and require Two Factor Authentication. We strongly recommend using Customer Tokens for that purpose, as they include pre-built Two Factor Authentication (OTP). If you would like to use an Org API token to access sensitive scopes, you would be responsible for executing the Two Factor Authentication. Please note that a successful authentication is considered valid for up to 24 hours.

Rate Limits

Our rate limit is based on your IP address and is set to 1,000 requests per minute. The limit applies to each environment (sandbox and production) separately. If the limit is exceeded, responses will include an HTTP 429 status code along with a relevant message.

Scopes

Scopes define the level of access a token will have to resources in Unit.

A list of all scopes within Unit:

Resource	Read Scope	Write Scope	Accessible Using
Application	application	application-write	Org API token
Customer Token	customer-token	customer-toke-write	Org API token
Customers	customers	customers-write	Org API token, Customer Token
Customer Tags	–	customer-tags-write	Org API token, Customer Token
Accounts	accounts	accounts-write	Org API token, Customer Token
Cards	cards	cards-write	Org API token, Customer Token
Cards Sensitive	cards-sensitive	cards-sensitive-write	Org API token, Customer Token
Transactions	transactions	transactions-write	Org API token, Customer Token
Authorizations	authorizations	–	Org API token, Customer Token
Statements	statements	–	Org API token, Customer Token
Payments	payments	payments-write	Org API token, Customer Token
Payments to a counterparty	–	payments-write-counterparty	Org API token, Customer Token
Payments ACH Debit	–	payments-write-ach-debit	Org API token, Customer Token
Counterparties	counterparties	counterparties-write	Org API token, Customer Token
Events	events	events-write	Org API token, Customer Token
Webhooks	webhooks	webhooks-write	Org API token
Authorization Requests	authorization-requests	authorization-requests-write	Org API token
Batch Releases	batch-releases	batch-releases-write	Org API token

Resource Type	Tag Support
Applications	Yes
Application Forms	Yes
Authorizations	No
Authorization Requests	No
Cards	Yes
Check Deposits	Yes
Counterparties	No
Customers	Inherited from Application
Deposit Accounts	Yes
Fees	Yes
Payments	Yes
Statements	No
Transactions	Inherited from Payment

Full-Text Search

The List operation under certain resources (such as Application, Customer or Transaction) supports full-text search, to help you find the desired resources more easily.

In particular, you can use full-text search to quickly build better end-customer experiences. An example would be adding a search box that lets end-customers search for transactions by merchant name (e.g. ‘starbucks’) when browsing transactions under their account.

Full-Text search rules:

unquoted text: text without quote marks will be converted into words separated by ‘And’ operators. Example: ‘john doe’ will search for a resource with the value ‘john’ and the value ‘doe’.
OR: will be converted into words separated by the ‘Or’ operator. Example: ‘john or doe’ will search for a resource with either the value ‘john’ or the value ‘doe’.
-: will be converted into the ‘Not’ operator. Example: ‘john -doe’ will search for a resource with the value ‘john’ and without the value ‘doe’.

Pagination

List operations on all resources (example: List Customers) return a list of resources.

To page through a long list, use the following two query parameters:

page[limit]: Limit the number of resources to be returned (between 1 and 1000). Defaults to 100 when no value is provided.
page[offset]: Number of resources to skip. Defaults to 0 when no value is provided.

Idempotency

Some of our API operations support request idempotency, allowing you to call a sensitive operation multiple times and assume that its work will be done no more than once. You may use any string of up to 255 characters as an idempotency key (we recommend UUID version 4).

The guarantee of idempotency is crucial when an API call has failed without a clear reason and a retry is due. For example, if creating a payment does not succeed due to a network error, you can safely retry creating the payment, passing the same idempotency key and assume the payment will occur no more than once, regardless of the number of calls.

Idempotency keys are guaranteed effective for 48 hours from the time they're used successfully. After this time window, they will be recycled and existing keys will therefore be treated as new.

Organization Accounts

Organization accounts (also known as org accounts) are special-purpose accounts that Unit sets up to support your activities. Unlike deposit accounts, org accounts existing on the org level and not under your customers.

Common types of org accounts include:

Revenue account: the account that Unit automatically credits with your org's interchange, interest and payment revenues.
Reserve account: the account that Unit automatically debits for a range of situations, including disputes and ACH returns. This account requires an initial balance to be funded, and monthly recalculation to determine the reserve amount required based on risk.
Cash Advance account: the account that Unit clients may use in the case of offering cash advances to customer.
Clearing account
Batch account: see Batch Payments

Your org accounts can be accessed from the Unit Dashboard. You may also access data in org accounts programmatically, in the same way that you access data in deposit accounts (for example, by calling List Transactions).

Changelog

We publish a monthly review of all the newest updates and features added to the platform on our Changelog. Subscribe to our newsletter to receive monthly updates on platform an product changes, directly to your inbox.

Roadmap

Check out our continuously updating public Roadmap to see what's planned for the coming months.

About JSON:API

Unit's API is REST-based and follows the JSON:API specification.

JSON:API specifies how a client should request resources to be fetched or modified, and how a server should respond to those requests. Resources in Unit include applications, customers, cards, accounts, transactions and more.

JSON:API is designed to minimize both the number of requests and the amount of data transmitted between clients and servers. This efficiency is achieved without compromising readability, flexibility, or discoverability.

JSON:API requires the use of the JSON:API media type (application/vnd.api+json) for exchanging data.

Request and Response Structure

Single Resource Object Example:

{
  "data": {
    "type": "individualCustomer",
    "id": "1",
    "attributes": {
      // ... this customer's attributes
    },
    "relationships": {
      // ... this customer's relationships
    }
  }
}

Array of Resource Objects Example:

{
    "data": [
        {
            "type": "individualCustomer",
            "id": "1",
            "attributes": {
              // ... this customer's attributes
            },
            "relationships": {
              // ... this customer's relationships
            }
        }, {
           "type": "businessCustomer",
           "id": "2",
           "attributes": {
             // ... this customer's attributes
           },
           "relationships": {
             // ... this customer's relationships
           }
       }
   ]       
}

All JSON:API requests and responses are JSON documents.

A document MUST contain one of the following top-level members:

data: the document's “primary data”. Example: when creating an individual application resource, the primary data will contain the individual's personal information.
errors: an array of error objects.

Primary data MUST be either:

a single resource object for requests that target single resources, or
an array of resource objects for requests that target resource collections.

Resource Object

Resource Example:

{
  "type": "individualCustomer",
  "id": "53",
  "attributes": {
    "createdAt": "2020-05-12T19:41:04.123Z",
    "fullName": {
      "first": "Peter",
      "last": "Parker"
    },
    "nationality": "US",
    "ssn": "721074426",
    "address": {
      "street": "20 Ingram St",
      "street2": null,
      "city": "Forest Hills",
      "state": "NY",
      "postalCode": "11375",
      "country": "US"
    },
    "dateOfBirth": "2001-08-15",
    "email": "peter@oscorp.com",
    "phone": {
      "countryCode": "1",
      "number": "15555555"
    }
  },
  "relationships": {
    // ... relationships
  }
}

JSON:API documents may contain resource objects to represent objects in the business domain. Unit's resources include applications, customers, cards, accounts, transactions and more.

A resource object MUST contain both the id and the type members.

Exception: the id member is not required when the resource object originates at the client and represents a new resource to be created on the server.

In addition, a resource object MAY contain these members:

attributes: an attributes object represents some of the resource’s data (examples include the resource name, address, email, etc.)
relationships: a relationship object describes the relationship between the current resource and other resources

Relationships

Resource with relationships example:

{
  "type": "depositAccount",
  "id": "50",
  "attributes": {
   // ...
  },
  "relationships": { // relationships object
    "customer": { // relationship object
      "data": { // resource linkage with single resource identifier
        "type": "businessCustomer",
        "id": "39"
      }
    }
  }
}

The relationships object describes the relationship between the current resource and other resources. Each member of the relationships object represents one reference.

In this example, we describe the relationship between a DepositAccount and the customer it belongs to.

Relationship

A “relationship object” MUST contain a data member with one of the following:

null for empty to-one relationships.
an empty array ([]) for empty to-many relationships.
a single resource identifier (type and id) for non-empty to-one relationships.
array of resource identifiers (type and id) for non-empty to-many relationships.

curl -X GET 'https://api.s.unit.sh/cards/41?include=customer,account' \
-H "Authorization: Bearer ${TOKEN}"

Get operations on certain resources (such as Card) contain an include query parameter that helps you get multiple related resources within the response. You may specify one or more relationships (comma-separated- see example). The response will then contain an included key with the related resources.

The ability to get related resources helps you turn multiple API calls into one. The result is cleaner code and no data integrity questions that usually arise when making multiple API calls at slightly different points in time.

Resource with included example:

{
  "data": {
    "type": "individualDebitCard",
    "id": "41",
    "attributes": {
      "createdAt": "2020-11-30T16:00:52.919Z",
      "last4Digits": "0261",
      "expirationDate": "2023-11",
      "status": "ClosedByCustomer"
    },
    "relationships": {
      "customer": {
        "data": {
          "type": "customer",
          "id": "10156"
        }
      },
      "account": {
        "data": {
          "type": "account",
          "id": "10075"
        }
      }
    }
  },
  "included": [
    {
      "type": "depositAccount",
      "id": "10075",
      "attributes": {
        "name": "April Oneil",
        "createdAt": "2020-11-30T15:56:59.670Z",
        "routingNumber": "812345678",
        "accountNumber": "1000000075",
        "depositProduct": "checking",
        "balance": 144785,
        "hold": 0,
        "available": 144785,
        "tags": {},
        "currency": "USD"
      },
      "relationships": {
        "customer": {
          "data": {
            "type": "customer",
            "id": "10156"
          }
        }
      }
    },
    {
      "type": "individualCustomer",
      "id": "10156",
      "attributes": {
        "createdAt": "2020-11-30T15:54:22.788Z",
        "fullName": {
          "first": "April",
          "last": "Oneil"
        },
        "ssn": "110000002",
        "address": {
          "street": "20 Ingram St",
          "city": "Forest Hills",
          "state": "CA",
          "postalCode": "11375",
          "country": "US"
        },
        "dateOfBirth": "2001-08-10",
        "email": "april@baxter.com",
        "phone": {
          "countryCode": "1",
          "number": "5555555555"
        },
        "soleProprietorship": false,
        "tags": {}
      },
      "relationships": {
        "application": {
          "data": {
            "type": "application",
            "id": "10186"
          }
        },
        "org": {
          "data": {
            "type": "org",
            "id": "1"
          }
        }
      }
    }
  ]
}

Errors

Unit's API uses HTTP Status Codes to communicate whether a request has been successfully processed. A request may stop processing as soon as a problem is encountered, or it may continue processing and encounter multiple problems. In either case, the response will contain all available errors.

An “error object” MUST contain a title and the HTTP status code members with one or more of the following:

code: a Unit-specific code, uniquely identifying the error type.
details: additional information about the error.

Webhooks

Unit uses webhooks to notify your application when an event occurs.

Example events: Application denied, Customer created, Transaction created. See Events for the full list.

When one of those events occurs, an HTTP POST request is sent to the webhook's configured URL, allowing you to act upon it.

Use Unit's Dashboard or API to create and manage your webhooks.

Unit sends POST requests to your webhook's URL from one of the following IP addresses:

Environment	IP Addresses
Sandbox	`54.81.62.38` `35.169.213.205`
Production	`3.209.193.26` `54.156.65.95`

Please note that these IP addresses are subject to change.

Securing your webhooks

Example of a NodeJS server verifying webhook payload

const express = require('express')
var crypto = require('crypto')
const app = express()
const port = 4000

app.post('/my-webhhok', (request, response) => {
  response.send('request passed signature validation...')
})

app.use(express.json());
app.use(express.urlencoded({
    extended: true
}));

app.use((request, response, next) => {
    var signature = request.header("x-unit-signature")
    var hmac = crypto.createHmac('sha1', <your secret>)
    hmac.update(JSON.stringify(request.body))

    if(hmac.digest('base64') == signature) {
        next()
    }
    else {
        response.status(500).send("Signatures didn't match!")
    }
  })


app.listen(port, (err) => {
  console.log(`server is listening on ${port}`)
})

Ensure your server is only receiving the expected Unit requests.

Once your server is configured to receive payloads, it'll listen for any payloads sent to the endpoint you configured.

For security reasons, you probably want to verify that the payloads are coming from Unit.

To verify the payloads when creating a webhook you can set up a secret token which Unit will use to sign the payloads.

Setting up your secret token

You'll need to set up your secret token in two places: Unit dashboard and your server. To set your token in Unit Dashboard:

Navigate to Webhooks on the left side menu.
Click on create and fill up the token field.

Verifying payloads from Unit

If your secret token is set, Unit will use it to create a hash signature with the entire body of the webhook request.

This hash signature, encoded with base64 is passed along with each request in the headers as X-Unit-Signature.

Unit uses an HMAC SHA1 to compute the hash.

Testing

To test the Webhook functionality you can use https://webhook.site. This site will let you generate a unique URL to use for your Webhook and then capture incoming requests, allowing you to examine the event's contents.

Another alternative is to use https://ngrok.com which enables you to expose a port on your development machine to the internet.

Create Webhook

Example Request:

curl -X POST 'https://api.s.unit.sh/webhooks' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type":"webhook",
    "attributes": {
      "label": "some label",
      "url": "https://webhook.site/81ee6b53-fde4-4b7d-85a0-0b6249a4488d",
      "token": "MyToken",
      "contentType": "Json"
    }
  }
}'

Creates a webhook.

Verb	`POST`
Url	`https://api.s.unit.sh/webhooks`
Required Scope	`webhooks-write`
Data Type	`webhook`

Attributes

Name	Type	Description
label	string	A label describing the webhook.
url	string	The URL of the webhook endpoint.
token	string	The secret token (see Securing your webhooks).
contentType	string	The type of content you wish to receive. Either `Json` or `JsonAPI`.

Get by Id

Get a webhook resource by id.

curl -X GET 'https://api.s.unit.sh/webhooks/10' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/webhooks/{id}`
Required Scope	`webhooks`

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	Webhook	The requested resource after the operation was completed.

List

List webhook resources. Paging can be applied.

curl -X GET 'https://api.s.unit.sh/webhooks?page[limit]=20&page[offset]=10' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/webhooks`
Required Scope	`webhooks`

Query Parameters

Name	Type	Default	Description
page[limit]	integer	100	Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
page[offset]	integer	0	Number of resources to skip. See Pagination.

Response

Example Response:

{
  "data": [
    {
      "type": "webhook",
      "id": "1",
      "attributes": {
        "createdAt": "2021-02-03T08:17:28.010Z",
        "label": "111",
        "url": "https://webhook.site/81ee6b53-fde4-4b7d-85a0-0b6249a4488c",
        "status": "Disabled",
        "contentType": "Json",
        "token": ""
      }
    },
    {
      "type": "webhook",
      "id": "2",
      "attributes": {
        "createdAt": "2021-02-09T14:54:42.612Z",
        "label": "some label",
        "url": "https://webhook.site/81ee6b53-fde4-4b7d-85a0-0b6249a4488d",
        "status": "Enabled",
        "contentType": "Json",
        "token": "MyToken"
      }
    }
  ]
}

Response is a JSON:API document.

200 OK

Field	Type	Description
data	Array of Webhook	Array of webhook resources.

Update

Example Request:

Update a webhook.

{
  "data": {
    "type": "webhook",
    "attributes": {
      "label": "some label",
      "contentType": "Json"
    }
  }
}

Verb	`PATCH`
Url	`https://api.s.unit.sh/webhooks/:id`
Required Scope	`webhooks-write`

Attributes

Name	Type	Description
label	string	The label of the webhook. To modify or add specify the new label.
url	string	The URL of the webhook endpoint. To modify or add specify the new URL.
contentType	string	The content type of the webhook. To modify or add specify the new content type.
token	string	The secret token of the webhook. To modify or add specify the token.

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	Webhook	The requested resource after the operation was completed.

Enable

Enable a webhook.

curl -X POST 'https://api.s.unit.sh/webhooks/7/enable' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`POST`
Url	`https://api.s.unit.sh/webhooks/:id/enable`
Required Scope	`webhooks-write`

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	Webhook	The requested resource after the operation was completed.

Disable

Disable a webhook.

curl -X POST 'https://api.s.unit.sh/webhooks/7/disable' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`POST`
Url	`https://api.s.unit.sh/webhooks/:id/disable`
Required Scope	`webhooks-write`

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	Webhook	The requested resource after the operation was completed.

Plaid

Unit and Plaid have partnered to offer Unit clients the benefits of being connected Plaid's network of banks and services:

Plaid Exchange Integration - enables Unit clients to be discoverable and connected to the more than 5,000 apps and services in the Plaid network.
Processor Link Integration - help Unit clients to move funds between accounts on Unit and any external bank account.

Plaid Exchange

Our Plaid Exchange integration will allow you to add your brand as an institution to Plaid’s open finance platform Plaid Exchange.

Official Account Name

On Plaid Exchange, accounts under the same customer should each have a unique official name, for example checking or savings. Unit will assign a name to each account by using the following values (in order of precedence):

plaidOfficialName tag on the account
purpose tag on the account
The depositProduct of the account

In order to control the official account name, set the plaidOfficialName tag to the name you choose. Please make sure the name is unique (within the same customer). If the name provided is not unique, Unit would add a sequence number as a suffix.

Plaid Link

To get started, see add Unit to your app under the Plaid docs.

Once you authenticate an external bank account with Plaid Link, you can pass the resulting Plaid token to certain Unit API endpoints. Unit will then inspect the Plaid token for the full details of that external account (routing number, account number & more) and treat it as a counterparty in payments.

Unit API endpoints that can receive a Plaid token are:

Create a Counterparty with a Plaid Token: use this endpoint if you foresee making multiple payments to or from the external bank account. Unit will then create a counterparty representing the external account described in the Plaid token, and you can refer to it when creating all future payments.
Create an ACH Payment with a Plaid Token: use this endpoint if you foresee making just one casual payment to or from the external bank account. Unit will then create a payment with the counterparty being the external account described in the Plaid token. However, no linked counterparty resource will be created.

How-To Guides

Below are common use cases for the Plaid integration and steps you'll need to follow to build them:

Helping a Customer Fund Their Account

Example: you've just created a deposit account for an individual customer. You'd like to help them fund it from a bank account that they own on another institution (e.g. Chase).

Follow these steps:

Use Plaid to authenticate the customer's account on Chase
Create a counterparty with the Plaid Token
Initiate an ACH Debit payment with the newly created counterparty to pull funds from Chase

Helping a Customer Withdraw Funds from Their Account

Example: a business customer holds an account with you and wants to withdraw funds from it into a bank account on another institution (e.g. Wells Fargo).

Follow these steps:

Use Plaid to authenticate the customer's account on Wells Fargo
Create a counterparty with the Plaid Token
Initiate an ACH Credit payment with the newly created counterparty to send funds to Wells Fargo

Helping a Customer Bill a Third Party

Example: a business customer holds a deposit account with you and wants to bill a client that has an account on another institution (e.g. Bank of America) for an invoice.

Follow these steps:

Use Plaid to authenticate the third party account on Bank of America
Create a counterparty with the Plaid Token
Initiate an ACH Debit payment with the newly created counterparty to pull funds from Bank of America

Helping a Customer Pay a Third Party

Example: a business customer holds a deposit account with you and wants to pay a vendor that has an account on another institution (e.g. Bank of America)

Follow these steps:

Use Plaid to authenticate the third party account on Bank of America
Create a counterparty with the Plaid Token
Initiate an ACH Credit payment with the newly created counterparty to send funds to Bank of America

Org API Tokens

Unit uses API Tokens to authenticate incoming requests. You can create API Tokens through Unit's Dashboard, or programmatically through an API call.

Create Org API Token

Creates an Org API token.

Example Request:

curl -X POST 'https://api.s.unit.sh/users/2/api-tokens' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data": {
    "type": "apiToken",
    "attributes": {
      "description": "Production token",
      "scope": "customers applications",
      "expiration": "2022-07-01T13:47:17.000Z"
    }
  }
}'

Verb	`POST`
Url	`https://api.s.unit.sh/users/:userId/api-tokens`
Data Type	`apiToken`

Attributes

Name	Type	Description
description	string	A description of the Org API token.
scope	string	list of Scopes separated by spaces.
expiration	RFC3339 Date string	Expiration date of the Org API token.
sourceIp	string	Optional. A comma separated list of IP addresses that are allowed to use the Org API token (no spaces allowed).

Response

Response is a JSON:API document.

Example Response:

{
  "data": {
    "id": "19",
    "type": "apiToken",
    "attributes": {
      "createdAt": "2021-07-01T08:51:09.108Z",
      "description": "Production token",
      "expiration": "2022-07-01T13:47:17.000Z",
      "token": "v2.public.eyJyb2xlIjoib3JnI..."
    }
  }
}

201 Created

Field	Type	Description
data	APIToken	A The newly created resource.

List

List Org API Token resources.

curl -X GET 'https://api.s.unit.sh/users/2/api-tokens' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/users/:userId/api-tokens`

Response

Example Response:

{
  "data": [
    {
      "id": "21",
      "type": "apiToken",
      "attributes": {
        "createdAt": "2021-07-01T09:13:23.211Z",
        "description": "Production token",
        "expiration": "2022-07-01T09:13:23.124Z"
      }
    },
    {
      "id": "22",
      "type": "apiToken",
      "attributes": {
        "createdAt": "2021-07-01T09:14:10.590Z",
        "description": "Testing token",
        "expiration": "2021-07-01T13:47:17.000Z",
        "sourceIp": "192.168.1.1,192.168.1.2"
      }
    }
  ]
}

Response is a JSON:API document.

200 OK

Field	Type	Description
data	Array of APIToken	Array of org api token resources.

Revoke

Revoke an Org API Token.

curl -X DELETE 'https://api.s.unit.sh/users/2/api-tokens/22' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`DELETE`
Url	`https://api.s.unit.sh/users/:userId/api-tokens/:tokenId`

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	APIToken	The requested resource after the operation was completed.

Customer API Tokens

Create a Customer Token to access customer specific data or execute sensitive actions (related to funds movement). Customer Tokens only allow access to resources that are associated with the specific customer the token was created for.

When you create a new customer token that has access to sensitive scopes, a one-time password will be sent to the customer, and must be provided in the create customer token API call in order to create the token. A customer token is valid for up to 24 hours (customizable).

How-To Guides

Below are common use cases for using a customer token and steps you’ll need to follow to build them:

Allowing a customer to view their debit cards

Example: Your application contains a page that displays the customer's debit cards.

Listing all cards of a customer example:

curl -X GET 'https://api.s.unit.sh/cards' \
-H "Authorization: Bearer ${CUSTOMER_TOKEN}"

Follow these steps:

Call the Create customer token with the cards scope included.
Call the List Cards operation and pass the customer token received in step #1 in the request Authorization header. No need to pass the filter[customerId] parameter since the token handles the filtering.

Allowing a customer to create a new debit card (requires two-factor authentication)

Example: Your application contains a page that enables debit card creation.

Creating a new debit card example:

curl -X POST 'https://api.s.unit.sh/cards' \
-H "Content-Type: application/vnd.api+json" \
-H "Authorization: Bearer ${CUSTOMER_TOKEN}" \
--data-raw '{
  "data":{
    "type":"individualDebitCard",
     "attributes": {
         "shippingAddress": {
             "street": "5230 Newell Rd",
             "city": "Palo Alto",
             "state": "CA",
             "postalCode": "94303",
             "country": "US"
         }
     },
     "relationships": {
         "account": {
             "data": {
                 "type": "depositAccount",
                 "id": "10001"
             }
         }
     }
  }
}
'

Follow these steps:

The customer clicks the Create Debit Card button on their cards application page.
Call the Create Customer Token Verification. This will return a verification token and will send the customer a verification code.
Allow the customer to enter the verification code they received.
Call the Create customer token with the cards-write scope included as well as the verification token received in step #2 and the verification code entered by the customer in step #3.
Call the Create Individual Debit Card and pass the customer token received in step #4 in the request Authorization header.

Create Customer Token

Example Request (two-factor authentication not required):

curl -X POST 'https://api.s.unit.sh/customers/8/token' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type":"customerToken",
    "attributes": {
      "scope": "customers accounts"
    }
  }
}
'

Listing all accounts of a customer:

curl -X GET 'https://api.s.unit.sh/accounts' \
-H "Authorization: Bearer ${CUSTOMER_TOKEN}"

Create a bearer token for a particular customer. The returned token can be used in the Authorization header as a secure alternative to the broader API token.

A Customer Token can only interact with resources under a particular customer. As an example, calling List Transactions with a customer bearer token will return only transactions within accounts under that particular customer.

Verb	`POST`
Url	`https://api.s.unit.sh/customers/:customerId/token`
Required Scope	`customer-token-write`
Data Type	`customerToken`

Example Request (two-factor authentication required)

{
  "data":{
    "type":"customerToken",
    "attributes": {
      "scope": "customers accounts-write accounts",
      "verificationToken": "i8FWKLBjXEg3TdeK93G3K9PKLzhbT6CRhn/VKkTsm....",
      "verificationCode": "203130"
    }
  }
}

Attributes

Name	Type	Description
scope	string	list of Scopes separated by spaces.
verificationToken	string	Received as a response from Create Customer Token Verification. Required if `scope` includes a scope which require two-factor authentication.
verificationCode	string	6 digits code sent to the customer through the desired channel. Required if the scope attribute includes a scope which requires two-factor authentication.
expiresIn	integer	Optional. The lifetime of the token (in seconds). Maximum value is `86400` (24 hours). Default value is also 24 hours.

Response

Example Response:

{
  "data": {
    "type": "customerBearerToken",
    "attributes": {
      "token": "v2.public.eyJyb2xlIjoiY3VzdG9tZX...",
      "expiresIn": 86400
    }
  }
}

Response is a JSON:API document.

201 Created

Field	Type	Description
data.attributes.token	string	The token issued for the customer.
data.attributes.expiresIn	integer	The lifetime of the token (in seconds).

Create Customer Token Verification

In order to increase security and prevent token theft, Unit supports two-factor authentication when creating a customer token.

When creating a customer token that contains a scope which requires two-factor authentication (see Scopes), it is required to first create a verification challenge that will be sent to the customer.

The challenge is a six digits code and is valid for 10 minutes after its creation.

The phone number that is used for the verification process is the one defined for the customer whose identifier is provided as part of the request params. An alternative phone number can be provided for Business Customers via the phone attribute (see below).

Create a token verification:

curl -X POST 'https://api.s.unit.sh/customers/10001/token/verification' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type":"customerTokenVerification",
    "attributes": {
      "channel": "sms"
    }
  }
}'

Verb	`POST`
Url	`https://api.s.unit.sh/customers/:customerId/token/verification`
Required Scope	`customers`
Data Type	`customerTokenVerification`

Attributes

Name	Type	Description
channel	string	send a verification code to the customer through one of the following channels `sms` or `call`.
phone	Phone	Optional. For BusinessCustomer only, this allows providing the phone number of one of the customer's authorized users. The provided phone must match an authorized user phone and will be used in the One Time Password (OTP) authentication process instead of the business customer contact's phone.
appHash	string	Optional. For sms verifications only, 11-character hash string that identifies your app. Appended at the end of your verification SMS body the way that client-side SMS Retriever API expects.

Example Response:

{
  "data": {
    "type": "customerTokenVerification",
    "attributes": {
      "verificationToken": "i8FWKLBjXEg3TdeK93G3K9PKLzhbT6CRhn/VKkTsm...."
    }
  }
}

201 Created

Field	Type	Description
verificationToken	string	The generated verification token . It should be passed back to Create Customer Bearer Token along with the verification code the customer received on the specified channel

Applications

Unit offers a short, low-friction, non-documentary application process - most applications will be approved in under five seconds. In some cases Unit detects an exception in the application process (e.g. a phone number mismatch), and certain documents are required in order to make a decision.

Unit will let you know exactly what documents to require from the customer, and once they are provided (via an API call), the application will either be approved automatically or manually reviewed by us (under an SLA of two business hours).

Application Statuses

The final statuses for an application are Approved or Denied. Once an application is approved, a Customer resource will be created and associated with the application resource. The new created customer resources will be referenced in the relationships object.

In most cases, an application will reach one of these final statuses immediately after creation, without requiring any documents.

In some cases, documents will be required and the application will enter an AwaitingDocuments status. Once you upload all the required documents, Unit will use the information provided to approve or deny the application. The decision may take seconds in some cases and up to two hours in other cases (when a manual review is required). Once the process is complete, you will receive a webhook containing the result.

An application can also be evaluated asynchronously, in which case its status will be Pending as long as the evaluation process is running. Once the process is complete, the status will change to either Approved, Denied or AwaitingDocuments and the relevant webhook event will be fired (see Pending status description below)

Below is a diagram describing the lifecycle of an application:

Below are all application statuses and their descriptions:

Status	Description
`AwaitingDocuments`	Certain documents are required for the process to continue. You may upload them via Upload Document.
`PendingReview`	The application is pending review by Unit (with an SLA of 2 business hours).
`Pending`	The application is being evaluated asynchronously and a result should be available shortly. Listen for webhooks (application.denied, customer.created and application.awaitingdocuments) for the final result, or periodically query the application with Get by Id).
`Approved`	The application was approved. A `Customer` resource was created.
`Denied`	The application was denied. A `Customer` resource will not be created.

Device Fingerprints

A Device fingerprint is a way to combine certain attributes of a device (operating system, IP address, device language settings etc.) in order to identify unique devices.

Unit partners with select providers to detect and prevent potential fraud. To enjoy improved protection, you must add the device fingerprint to new application.

Providers

Name	Description
Iovation	The Iovation (TransUnion TruValidate) device fingerprint string is called a “blackbox”, the blackbox can be generated using their Android SDK or iOS SDK.

Create Individual Application

Create an application for an individual end-customer.

Example Request:

curl -X POST 'https://api.s.unit.sh/applications' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data": {
    "type": "individualApplication",
    "attributes": {
      "ssn": "721074426",
      "fullName": {
        "first": "Peter",
        "last": "Parker"
      },
      "dateOfBirth": "2001-08-10",
      "address": {
        "street": "20 Ingram St",
        "city": "Forest Hills",
        "state": "NY",
        "postalCode": "11375",
        "country": "US"
      },
      "email": "peter@oscorp.com",
      "phone": {
        "countryCode": "1",
        "number": "5555555555"
      },
      "ip": "127.0.0.1",
      "soleProprietorship": true,
      "ein": "123456789",
      "dba": "Piedpiper Inc",
      "tags": {
        "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
      },
      "idempotencyKey": "3a1a33be-4e12-4603-9ed0-820922389fb8"
    }
  }
}'

Verb	`POST`
Url	`https://api.s.unit.sh/applications`
Required Scope	`applications-write`
Data Type	`individualApplication`

Attributes

Name	Type	Description
ssn	string	SSN (or ITIN) of the individual (numbers only). Either an SSN or a passport number is required.
passport	string	Passport number of the individual. Either an SSN or a passport is required.
nationality	ISO31661-Alpha2 string	Required on passport only. Two letters representing the individual nationality. (e.g. “US”).
fullName	FullName	Full name of the individual.
dateOfBirth	RFC3339 Date string	Date only (e.g. `"2001-08-15"`).
address	Address	Address of the individual.
phone	Phone	Phone number of the individual.
email	string	Email address of the individual.
ip	string	IP address of the end-customer creating the application. Both IPv4 and IPv6 formats are supported.
soleProprietorship	boolean	Optional. Default: false. Indicates whether the individual is a sole proprietor.
ein	string	Optional. If the individual is a sole proprietor who has an Employer Identification Number, specify it here. Not all sole proprietors have an EIN, so this attribute is optional, even when `soleProprietorship` is set to `true`.
dba	string	Optional. If the individual is a sole proprietor who is doing business under a different name, specify it here. This attribute is optional, even when `soleProprietorship` is set to `true`.
tags	object	See Tags. Tags that will be copied to the customer that this application creates (see Tag Inheritance).
idempotencyKey	string	See Idempotency.
deviceFingerprints	Array of Device Fingerprint	Optional. A list of device fingerprints for fraud and risk prevention (See Device Fingerprints).

Response

Response is a JSON:API document.

Example Response:

{
  "data": {
    "type": "individualApplication",
    "id": "53",
    "attributes": {
      "createdAt": "2020-01-14T14:05:04.718Z",
      "fullName": {
        "first": "Peter",
        "last": "Parker"
      },
      "ssn": "721074426",
      "address": {
        "street": "20 Ingram St",
        "street2": null,
        "city": "Forest Hills",
        "state": "NY",
        "postalCode": "11375",
        "country": "US"
      },
      "dateOfBirth": "2001-08-10",
      "email": "peter@oscorp.com",
      "phone": {
        "countryCode": "1",
        "number": "5555555555"
      },
      "status": "AwaitingDocuments",
      "ip": "127.0.0.1",
      "soleProprietorship": true,
      "ein": "123456789",
      "dba": "Piedpiper Inc",
      "tags": {
        "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
      }
    },
    "relationships": {
      "org": {
        "data": {
          "type": "org",
          "id": "1"
        }
      },
      "documents": {
        "data": [
          {
            "type": "document",
            "id": "1"
          },
          {
            "type": "document",
            "id": "2"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "document",
      "id": "1",
      "attributes": {
        "documentType": "AddressVerification",
        "status": "Required",
        "name": "Peter Parker",
        "description": "Please provide a document to verify your address. Document may be a utility bill, bank statement, lease agreement or current pay stub.",
        "address": {
          "street": "20 Ingram St",
          "street2": null,
          "city": "Forest Hills",
          "state": "NY",
          "postalCode": "11375",
          "country": "US"
        }
      }
    },
    {
      "type": "document",
      "id": "2",
      "attributes": {
        "documentType": "IdDocument",
        "status": "Required",
        "name": "Peter Parker",
        "description": "Please provide a copy of your unexpired government issued photo ID which would include Drivers License or State ID.",
        "dateOfBirth": "2001-08-10"
      }
    }
  ]

}

201 Created

Field	Type	Description
data	IndividualApplication	The newly created resource.
included	Array of ApplicationDocument Resource	Required documents for this application. Each document resource includes the document status.

Create Business Application

Create an application for a business end-customer.

Example Request:

curl -X POST 'https://api.s.unit.sh/applications' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data": {
    "type": "businessApplication",
    "attributes": {
      "name": "Pied Piper",
      "address": {
        "street": "5230 Newell Rd",
        "city": "Palo Alto",
        "state": "CA",
        "postalCode": "94303",
        "country": "US"
      },
      "phone": {
        "countryCode": "1",
        "number": "5555555555"
      },
      "stateOfIncorporation": "DE",
      "ein": "123456789",
      "entityType": "Corporation",
      "ip": "127.0.0.1",
      "website": "https://www.piedpiper.com",
      "contact": {
        "fullName": {
          "first": "Richard",
          "last": "Hendricks"
        },
        "email": "richard@piedpiper.com",
        "phone": {
          "countryCode": "1",
          "number": "5555555555"
        }
      },
      "officer": {
        "fullName": {
          "first": "Richard",
          "last": "Hendricks"
        },
        "dateOfBirth": "2001-08-10",
        "title": "CEO",
        "ssn": "721074426",
        "email": "richard@piedpiper.com",
        "phone": {
          "countryCode": "1",
          "number": "5555555555"
        },
        "address": {
          "street": "5230 Newell Rd",
          "city": "Palo Alto",
          "state": "CA",
          "postalCode": "94303",
          "country": "US"
        }
      },
      "beneficialOwners": [
        {
          "fullName": {
            "first": "Richard",
            "last": "Hendricks"
          },
          "dateOfBirth": "2001-08-10",
          "ssn": "123456789",
          "email": "richard@piedpiper.com",
          "percentage": 75,
          "phone": {
            "countryCode": "1",
            "number": "5555555555"
          },
          "address": {
            "street": "5230 Newell Rd",
            "city": "Palo Alto",
            "state": "CA",
            "postalCode": "94303",
            "country": "US"
          }
        }
      ],
      "tags": {
        "userId": "2ab1f266-04b9-41fb-b728-cd1962bca52c"
      },
      "idempotencyKey": "3a1a33be-4e12-4603-9ed0-820922389fb8"
    }
  }
}'

Verb	`POST`
Url	`https://api.s.unit.sh/applications`
Required Scope	`applications-write`
Data Type	`businessApplication`

Attributes

Name	Type	Description
name	string	Name of the business.
dba	string	Optional. “Doing business as”.
address	Address	Address of the business.
phone	Phone	Phone number of the business.
stateOfIncorporation	string	Two letters representing a US state.
ein	string	Business EIN (numbers only).
entityType	string	One of `"Corporation"`, `"LLC"` or `"Partnership"`.
ip	string	IP address of the end-customer creating the application. Both IPv4 and IPv6 formats are supported.
website	string	Business's website. Optional.
contact	BusinessContact	Primary contact of the business.
officer	Officer	Officer representing the business (must be the CEO, COO, CFO, President or BenefitsAdministrationOfficer). To onboard a business successfully, you must provide the officer's personal details.
beneficialOwners	Array of BeneficialOwner	Array of beneficial owners in the business. Beneficial owners are all people that, directly or indirectly, own 25% or more of the business. To onboard a business successfully, you must provide each beneficial owner's personal details.
tags	object	See Tags. Tags that will be copied to the customer that this application creates (see Tag Inheritance).
idempotencyKey	string	See Idempotency.
deviceFingerprints	Array of Device Fingerprint	Optional. A list of device fingerprints for fraud and risk prevention (See Device Fingerprints).

Response

Response is a JSON:API document.

201 Created

Field	Type	Description
data	BusinessApplication	The newly created resource.
included	Array of ApplicationDocument Resource	Required documents for this application. Each document resource includes the document status.

Example Response:

{
  "data": {
    "type": "businessApplication",
    "id": "50",
    "attributes": {
      "createdAt": "2020-01-13T16:01:19.346Z",
      "name": "Pied Piper",
      "dba": null,
      "address": {
        "street": "5230 Newell Rd",
        "street2": null,
        "city": "Palo Alto",
        "state": "CA",
        "postalCode": "94303",
        "country": "US"
      },
      "phone": {
        "countryCode": "1",
        "number": "5555555555"
      },
      "stateOfIncorporation": "DE",
      "ein": "123456789",
      "entityType": "Corporation",
      "contact": {
        "fullName": {
          "first": "Richard",
          "last": "Hendricks"
        },
        "email": "richard@piedpiper.com",
        "phone": {
          "countryCode": "1",
          "number": "5555555555"
        }
      },
      "officer": {
        "fullName": {
          "first": "Richard",
          "last": "Hendricks"
        },
        "ssn": "123456789",
        "address": {
          "street": "5230 Newell Rd",
          "street2": null,
          "city": "Palo Alto",
          "state": "CA",
          "postalCode": "94303",
          "country": "US"
        },
        "dateOfBirth": "2001-08-10",
        "title": "CEO",
        "email": "richard@piedpiper.com",
        "phone": {
          "countryCode": "1",
          "number": "5555555555"
        },
        "status": "Approved"
      },
      "beneficialOwners": [
        {
          "fullName": {
            "first": "Richard",
            "last": "Hendricks"
          },
          "ssn": "123456789",
          "address": {
            "street": "5230 Newell Rd",
            "street2": null,
            "city": "Palo Alto",
            "state": "CA",
            "postalCode": "94303",
            "country": "US"
          },
          "dateOfBirth": "2001-08-10",
          "phone": {
            "countryCode": "1",
            "number": "5555555555"
          },
          "email": "richard@piedpiper.com",
          "percentage": 75,
          "status": "Approved"
        }
      ],
      "tags": {
        "userId": "2ab1f266-04b9-41fb-b728-cd1962bca52c"
      },
      "status": "AwaitingDocuments"
    },
    "relationships": {
      "org": {
        "data": {
          "type": "org",
          "id": "1"
        }
      },
      "documents": {
        "data": [
          {
            "type": "document",
            "id": "1"
          },
          {
            "type": "document",
            "id": "2"
          },
          {
            "type": "document",
            "id": "3"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "document",
      "id": "1",
      "attributes": {
        "documentType": "CertificateOfIncorporation",
        "status": "Required",
        "name": "Pied Piper",
        "description": "For Corporation: Please provide a certified copy of the Articles of Incorporation or Certificate of Incorporation..."
      }
    },
    {
      "type": "document",
      "id": "2",
      "attributes": {
        "documentType": "AddressVerification",
        "status": "Required",
        "name": "Richard Hendricks",
        "description": "Please provide a document to verify your address. Document may be a utility bill, bank statement, lease agreement or current pay stub.",
        "address": {
          "street": "5230 Newell Rd",
          "street2": null,
          "city": "Palo Alto",
          "state": "CA",
          "postalCode": "94303",
          "country": "US"
        }
      }
    },
    {
      "type": "document",
      "id": "3",
      "attributes": {
        "documentType": "IdDocument",        
        "status": "Required",
        "name": "Richard Hendricks",
        "description": "Please provide a copy of your unexpired government issued photo ID which would include Drivers License or State ID."
      }
    }
  ]
}

Get by Id

Get an application resource by id.

curl -X GET 'https://api.s.unit.sh/applications/43' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/applications/{id}`
Required Scope	`applications`

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	IndividualApplication or BusinessApplication	Application resource. Can be either business or individual, as indicated by the `type` field.
included	Array of ApplicationDocument Resource	Application required documents, each document object also include the document status.

List

List application resources. Paging can be applied.

curl -X GET 'https://api.s.unit.sh/applications?page[limit]=20&page[offset]=10' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/applications`
Required Scope	`applications`

Query Parameters

Name	Type	Default	Description
page[limit]	integer	100	Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
page[offset]	integer	0	Number of resources to skip. See Pagination.
filter[query]	string	(empty)	Optional. Search term according to the Full-Text Search Rules.
filter[email]	string	(empty)	Optional. Filter applications by email address (case sensitive).
filter[tags]	Tags (JSON)	(empty)	Optional. Filter Applications by Tags.
sort	string	`sort=-createdAt`	Optional. `sort=createdAt` for ascending order or `sort=-createdAt` (leading minus sign) for descending order.

Response

Example Response:

{
  "data": [
    {
      "type": "individualApplication",
      "id": "1",
      "attributes": {
        "createdAt": "2020-01-15T13:47:36.098Z",
        "fullName": {
          "first": "Peter",
          "last": "Parker"
        },
        "ssn": "721074426",
        "address": {
          "street": "20 Ingram St",
          "street2": null,
          "city": "Forest Hills",
          "state": "NY",
          "postalCode": "11375",
          "country": "US"
        },
        "dateOfBirth": "2001-08-10",
        "email": "peter@oscorp.com",
        "phone": {
          "countryCode": "1",
          "number": "5555555555"
        },
        "status": "AwaitingDocuments",
        "message": "Waiting for you to upload the required documents."
      },
      "relationships": {
        "org": {
          "data": {
            "type": "org",
            "id": "1"
          }
        },
        "documents": {
          "data": [
            {
              "type": "document",
              "id": "1"
            },
            {
              "type": "document",
              "id": "2"
            }
          ]
        }
      }
    },
    {
      "type": "businessApplication",
      "id": "2",
      "attributes": {
        "createdAt": "2020-01-15T13:48:38.527Z",
        "name": "Pied Piper",
        "dba": null,
        "address": {
          "street": "5230 Newell Rd",
          "street2": null,
          "city": "Palo Alto",
          "state": "CA",
          "postalCode": "94303",
          "country": "US"
        },
        "phone": {
          "countryCode": "1",
          "number": "5555555555"
        },
        "stateOfIncorporation": "DE",
        "ein": "123456789",
        "entityType": "Corporation",
        "contact": {
          "fullName": {
            "first": "Richard",
            "last": "Hendricks"
          },
          "email": "richard@piedpiper.com",
          "phone": {
            "countryCode": "1",
            "number": "5555555555"
          }
        },
        "officer": {
          "fullName": {
            "first": "Richard",
            "last": "Hendricks"
          },
          "ssn": "123456789",
          "address": {
            "street": "5230 Newell Rd",
            "street2": null,
            "city": "Palo Alto",
            "state": "CA",
            "postalCode": "94303",
            "country": "US"
          },
          "dateOfBirth": "2001-08-10",
          "email": "richard@piedpiper.com",
          "phone": {
            "countryCode": "1",
            "number": "5555555555"
          },
          "status": "Approved"
        },
        "beneficialOwners": [
          {
            "fullName": {
              "first": "Richard",
              "last": "Hendricks"
            },
            "ssn": "123456789",
            "address": {
              "street": "5230 Newell Rd",
              "street2": null,
              "city": "Palo Alto",
              "state": "CA",
              "postalCode": "94303",
              "country": "US"
            },
            "dateOfBirth": "2001-08-10",
            "phone": {
              "countryCode": "1",
              "number": "5555555555"
            },
            "email": "richard@piedpiper.com",
            "status": "Approved"
          }
        ],
        "status": "AwaitingDocuments",
        "message": "Waiting for you to upload the required documents."
      },
      "relationships": {
        "org": {
          "data": {
            "type": "org",
            "id": "1"
          }
        },
        "documents": {
          "data": [
            {
              "type": "document",
              "id": "1"
            },
            {
              "type": "document",
              "id": "2"
            },
            {
              "type": "document",
              "id": "3"
            }
          ]
        }
      }
    }
  ]
}

Response is a JSON:API document.

200 OK

Field	Type	Description
data	Array of IndividualApplication or BusinessApplication	Array of application resources. Each resource can be either business or individual, as indicated by the `type` field.

Application Documents

Application document resources represent the documents that need to be collected for the application to be evaluated. Their initial status is always Required. The documents will be different in the case of individual and business applications.

Application document resources are created automatically once an application is created.

When creating an application or getting an application by id, the documents are included in the response included top-level field.

Application Document Status

Status	Description
`Required`	The document is required for the application to be evaluated.
`ReceivedBack`	Back-side of the document was received. Front-side is still required. Only relevant for `IdDocument` document type.
`ReceivedFront`	Front-side of the document was received. Back-side is still required. Only relevant for `IdDocument` document type.
`Invalid`	The document is invalid. You may re-upload the correct document for the application to be evaluated.
`Approved`	The document is approved.
`PendingReview`	The document is currently undergoing review.

Document Types

Name	Description
`IdDocument`	An individual's Drivers License or State ID. Both front-side and back-side are required.
`Passport`	An individual's passport.
`AddressVerification`	An individual's document to verify address. Document may be a utility bill, bank statement, lease agreement or current pay stub.
`SocialSecurityCard`	An individual's social security card.
`CertificateOfIncorporation`	A business's certificate of incorporation.
`EmployerIdentificationNumberConfirmation`	A business's EIN confirmation document (either IRS form 147c or IRS form CP-575).

Upload Document

Uploads a document file. Supported file types are pdf, jpeg or png.

curl --request PUT 'https://api.s.unit.sh/applications/46/documents/3' \
--header 'Content-Type: application/pdf' \
--data-binary 'passport.pdf'

Verb	`PUT`
Url	`https://api.s.unit.sh/applications/{applicationId}/documents/{documentId}`
Required Scope	`applications-write`

Headers

Header	Value
Content-Type	One of `image/png`, `image/jpeg`, or `application/pdf`.

Response

Example Response:

{
    "data": {
        "type": "document",
        "id": "3",
        "attributes": {
            "documentType": "Passport",
            "status": "Approved",
            "description": "Please provide a current copy of your passport.",
            "name": "Richard Hendricks",
            "dateOfBirth": "2001-08-15"
        }
    }
}

Response is a JSON:API document.

200 OK

Field	Type	Description
data	ApplicationDocument	The target resource after the operation was completed.

Upload Document Back-Side

Uploads the back-side of a document. Supported file types are pdf, jpeg or png.

curl --request PUT 'https://api.s.unit.sh/applications/46/documents/3/back' \
--header 'Content-Type: application/pdf' \
--data-binary 'driver-license-back.pdf'

Verb	`PUT`
Url	`https://api.s.unit.sh/applications/{applicationId}/documents/{documentId}/back`
Required Scope	`applications-write`

Headers

Header	Value
Content-Type	One of `image/png`, `image/jpeg`, or `application/pdf`.

Response

Example Response:

{
    "data": {
        "type": "document",
        "id": "3",
        "attributes": {
            "documentType": "IdDocument",
            "status": "Approved",
            "description": "Please provide a copy of your unexpired government issued photo ID which would include Drivers License or State ID.",
            "name": "Richard Hendricks",
            "dateOfBirth": "2001-08-15"
        }
    }
}

Response is a JSON:API document.

200 OK

Field	Type	Description
data	ApplicationDocument	The target resource after the operation was completed.

List

List application documents.

curl -X GET 'https://api.s.unit.sh/applications/1/documents' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/applications/{applicationId}/documents`
Required Scope	`applications`

You can also list the application documents via Get Application by Id, the documents will be included in the response included top-level field.

Response

Example Response:

{
  "data": [
    {
      "type": "document",
      "id": "1",
      "attributes": {
        "documentType": "CertificateOfIncorporation",
        "status": "Required",
        "description": "Please provide a certified copy of the Articles of Incorporation or Certificate of Incorporation.",
        "name": "Pied Piper"
      }
    },
    {
      "type": "document",
      "id": "2",
      "attributes": {
        "documentType": "AddressVerification",
        "status": "Required",
        "description": "Please provide a document to verify your address. Document may be a utility bill, bank statement, lease agreement or current pay stub.",
        "name": "Richard Hendricks",
        "address": {
          "street": "5230 Newell Rd",
          "street2": null,
          "city": "Palo Alto",
          "state": "CA",
          "postalCode": "94303",
          "country": "US"
        }
      }
    },
    {
      "type": "document",
      "id": "3",
      "attributes": {
        "documentType": "IdDocument",
        "status": "Required",
        "description": "Please provide a copy of your unexpired government issued photo ID which would include Drivers License or State ID.",
        "name": "Richard Hendricks"
      }
    }
  ]
}

Response is a JSON:API document.

200 OK

Field	Type	Description
data	Array of ApplicationDocument Resource	Array of application documents.

Application Forms

Unit offers a fully customizable onboarding front-end that allows you to onboard end-customers, both individuals and businesses.

Using Unit's white-label experience has many benefits:

Shorter time to market compared to building your own flow.
Benefit from Unit's technology, compliance and fraud expertise - Unit's onboarding experience offers responsive, mobile friendly design, and will include (in subsequent releases) phone number verification and on-device fraud detection measures to reduce fraud risk. We monitor and track the application form closely, and it will continue to develop and deliver a frictionless experience that guarantees you are compliant with the evolving regulation.
No maintenance required: any future changes to the onboarding process will be handled by Unit.

(.Get 1)

If you prefer to build your own custom experience, you may still do so using Unit's Applications API.

How does it work:

You may create a new application form by using the Create Application Form endpoint. When you make this call, you can specify:

Any information you have on the customer that can be used to pre-fill the application form
Your preferences/restrictions for this specific application (e.g. Individual vs Business application)

When the API call is received, Unit will create an application form resource, and generate an application form link. This link is returned in the response to the API call, along with an application form ID. This link is valid for 24 hours, and you can receive a fresh link that will allow the user to resume the application by calling the GET application form endpoint. It is up to you to manage the distribution of this link and manage all communication around the application form (sending emails, or redirecting the customers).

Create Application Form

To onboard an end-customer through Unit's UI, create an ApplicationForm resource

The application form implements the Create Individual Application or Create Business Application calls, depending on the user's choice in the interface.

Example Request:

curl -X POST 'https://api.s.unit.sh/application-forms' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data": {
    "type": "applicationForm",
    "attributes": {
      "tags": {
        "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
      }
    }
  }
}'

Verb	`POST`
Url	`https://api.s.unit.sh/application-forms`
Required Scope	`applications-write`
Data Type	`applicationForm`

Attributes

Name	Type	Description
tags	object	See Tags. Tags that will be copied to the application that this form creates (see Tag Inheritance).
applicantDetails	ApplicationFormPrefill	Optional. Add data that is already known about the end-customer to be auto populated on the form.

Response

Response is a JSON:API document.

Example Response:

{
  "data": {
    "type": "applicationForm",
    "id": "95",
    "attributes": {
      "tags": {
        "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
      },
      "url": "https://application-form.sh/6YZ3UG6RS7NGTO5ZB3A4SRO3NEYPJUREYIIKZDOOX2CTWBPZ4A343UB4KZSQRF3DHHKYECF4S45VP7Y2YUP5WGEHO4YVH25Q24JRM4UA5IW3OM552HAFJ3HIVIUJGJBFQ4UJMZ3VGXUG6L5XFKE2W7YX7KDOC2J"
    }
  }
}

201 Created

Field	Type	Description
tags	object	See Tags. Tags that will be copied to the application that this form creates (see Tag Inheritance).
url	string	The URL of the application form for the end-customer to access
applicantDetails	ApplicationFormPrefill	Data that is already known about the end-customer to be auto populated on the form.

Get by Id

Get an application form resource by id.

You will receive a fresh 24-hour URL for the existing form, allowing the customer to resume the application.

curl -X GET 'https://api.s.unit.sh/application-forms/21' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/application-forms/{id}`
Required Scope	`application-forms`

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
tags	object	See Tags. Tags that will be copied to the application that this form creates (see Tag Inheritance).
url	string	The URL of the application form for the end-customer to access

Customers

Customers represent individuals or businesses that you may create financial products for.

You cannot create customer resources directly — they are automatically created once an application is approved.

A customer can be either BusinessCustomer or IndividualCustomer.

Update Individual Customer

Update an IndividualCustomer.

Update an individual customer:

curl -X PATCH 'https://api.s.unit.sh/customers/:customerId' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type": "individualCustomer",
    "attributes": {
      "address": {
        "street": "5231 Newell Rd",
        "street2": null,
        "city": "Palo Alto",
        "state": "CA",
        "postalCode": "94301",
        "country": "US"
      },
      "email": "richard@piedpiper.com",
      "phone": {
        "countryCode": "1",
        "number": "5555555555"
      }
    }
  }
}'

Verb	`PATCH`
Url	`https://api.s.unit.sh/customers/:customerId`
Required Scope	`customers-write` or `customer-tags-write`
Data Type	`individualCustomer`

Attributes

Name	Type	Description
address	Address	Address of the individual. To modify or add specify the new address.
phone	Phone	Phone of the individual. To modify or add specify the new phone number.
email	string	Email address of the individual. To modify or add specify the new email address.
dba	string	If the individual is a sole proprietor who is doing business under a different name. To modify or add specify the new dba name.
tags	object	See Updating Tags.

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	IndividualCustomer	Customer resource.

Update Business Customer

Update an BusinessCustomer.

Update business customer:

curl -X PATCH 'https://api.s.unit.sh/customers/:customerId' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type": "businessCustomer",
    "attributes": {
      "address": {
        "street": "5231 Newell Rd",
        "street2": null,
        "city": "Palo Alto",
        "state": "CA",
        "postalCode": "94301",
        "country": "US"
      },
      "phone": {
        "countryCode": "1",
        "number": "5555555555"
      },
      "contact": {
        "fullName": {
          "first": "Jone",
          "last": "Doe"
        },
        "email": "jone.doe@unit-finance.com",
        "phone": {
          "countryCode": "1",
          "number": "2025550108"
        }
      },
      "authorizedUsers": [
        {
          "fullName": {
            "first": "Jared",
            "last": "Dunn"
          },
          "email": "jared@piedpiper.com",
          "phone": {
            "countryCode": "1",
            "number": "1555555590"
          }
        }
      ]
    }
  }
}'

Verb	`PATCH`
Url	`https://api.s.unit.sh/customers/:customerId`
Required Scope	`customers-write` or `customer-tags-write`
Data Type	`businessCustomer`

Attributes

Name	Type	Description
address	Address	Address of the business. To modify specify the new address.
phone	Phone	Phone of the business. To modify specify the new phone number.
contact	BusinessContact	Primary contact of the business.
authorizedUsers	Array of AuthorizedUser	Array of authorized users. The provided array items will replace the existing ones.
tags	object	See Updating Tags.

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	BusinessCustomer	Customer resource.

Get by Id

Get a customer resource by id.

curl -X GET 'https://api.s.unit.sh/customers/8' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/customers/{id}`
Required Scope	`customers`

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	BusinessCustomer or IndividualCustomer	Customer resource. Can be either business or individual, as indicated by the `type` field.

List

List customer resources. Paging can be applied.

curl -X GET 'https://api.s.unit.sh/customers?page[limit]=20&page[offset]=10' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/customers`
Required Scope	`customers`

Query Parameters

Name	Type	Default	Description
page[limit]	integer	100	Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
page[offset]	integer	0	Number of resources to skip. See Pagination.
filter[query]	string	(empty)	Optional. Search term according to the Full-Text Search Rules.
filter[email]	string	(empty)	Optional. Filter customers by email address (case sensitive).
filter[tags]	Tags (JSON)	(empty)	Optional. Filter Customers by Tags.
sort	string	`sort=-createdAt`	Optional. `sort=createdAt` for ascending order or `sort=-createdAt` (leading minus sign) for descending order.

Response

Example Response:

{
  "data": [
    {
      "type": "businessCustomer",
      "id": "1",
      "attributes": {
        "createdAt": "2020-05-10T12:28:37.698Z",
        "name": "Pied Piper",
        "address": {
          "street": "5230 Newell Rd",
          "street2": null,
          "city": "Palo Alto",
          "state": "CA",
          "postalCode": "94303",
          "country": "US"
        },
        "phone": {
          "countryCode": "1",
          "number": "1555555566"
        },
        "stateOfIncorporation": "DE",
        "ein": "123456789",
        "entityType": "Corporation",
        "contact": {
          "fullName": {
            "first": "Richard",
            "last": "Hendricks"
          },
          "email": "richard@piedpiper.com",
          "phone": {
            "countryCode": "1",
            "number": "1555555566"
          }
        }
      },
      "relationships": {
        "org": {
          "data": {
            "type": "org",
            "id": "1"
          }
        },
        "application": {
          "data": {
            "type": "businessApplication",
            "id": "1"
          }
        }
      }
    },
    {
      "type": "individualCustomer",
      "id": "8",
      "attributes": {
        "createdAt": "2020-05-12T19:41:04.123Z",
        "fullName": {
          "first": "Peter",
          "last": "Parker"
        },
        "ssn": "721074426",
        "address": {
          "street": "20 Ingram St",
          "street2": null,
          "city": "Forest Hills",
          "state": "NY",
          "postalCode": "11375",
          "country": "US"
        },
        "dateOfBirth": "2001-08-10",
        "email": "peter@oscorp.com",
        "phone": {
          "countryCode": "1",
          "number": "1555555566"
        }
      },
      "relationships": {
        "org": {
          "data": {
            "type": "org",
            "id": "1"
          }
        },
        "application": {
          "data": {
            "type": "individualApplication",
            "id": "8"
          }
        }
      }
    }
  ]
}

Response is a JSON:API document.

200 OK

Field	Type	Description
data	Array of BusinessCustomer or IndividualCustomer	Array of customer resources. Each resource can be either business or individual, as indicated by the `type` field.

Deposit Accounts

Create Deposit Account

Example Request:

curl -X POST 'https://api.s.unit.sh/accounts' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data": {
    "type": "depositAccount",
    "attributes": {
      "depositProduct": "checking",
      "tags": {
        "purpose": "checking"
      },
      "idempotencyKey": "3a1a33be-4e12-4603-9ed0-820922389fb8"
    },
    "relationships": {
      "customer": {
        "data": {
          "type": "customer",
          "id": "45555"
        }
      }
    }
  }
}'

Creates a deposit account for a Customer using a specified deposit product. A deposit product is a predefined set of terms associated with this deposit account (e.g. interest rate).

For testing, use the checking deposit product. Contact Unit to create other deposit products under your organization.

Deposit Account creation request supports Idempotency, ensuring that performing multiple identical requests will have the same effect as performing a single request.

Verb	`POST`
Url	`https://api.s.unit.sh/accounts`
Required Scope	`accounts-write`
Data Type	`depositAccount`

Attributes

Name	Type	Description
depositProduct	string	The name of the deposit product.
tags	object	See Tags.
idempotencyKey	string	See Idempotency.

Relationships

Name	Type	Description
customer	JSON:API Relationship	The customer the deposit account belongs to. The customer is either a business or an individual customer.

Response

Response is a JSON:API document.

Example Response:

{
  "data": {
    "type": "depositAccount",
    "id": "42",
    "attributes": {
      "createdAt": "2000-05-11T10:19:30.409Z",
      "name": "Peter Parker",
      "status": "Open",
      "depositProduct": "checking",
      "routingNumber": "812345678",
      "accountNumber": "1000000002",
      "currency": "USD",
      "balance": 10000,
      "hold": 0,
      "available": 10000,
      "tags": {
        "purpose": "checking"
      }
    },
    "relationships": {
      "customer": {
        "data": {
          "type": "customer",
          "id": "45555"
        }
      }
    }
  }
}

201 Created

Field	Type	Description
data	DepositAccount	The requested resource after the operation was completed.

Close Account

Closes an account.

curl -X POST 'https://api.s.unit.sh/accounts/10000/close' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`POST`
Url	`https://api.s.unit.sh/accounts/:accountId/close`
Required Scope	`accounts-write`
Data Type	`accountClose`

Attributes

Name	Type	Description
reason	string	Optional. The reason for closing the account. Either `ByCustomer` or `Fraud`. If not specified, will default to `ByCustomer`.

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	DepositAccount	Deposit Account resource.

Reopen Account

Reopen an account.

curl -X POST 'https://api.s.unit.sh/accounts/10000/reopen' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`POST`
Url	`https://api.s.unit.sh/accounts/:accountId/reopen`
Required Scope	`accounts-write`

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	DepositAccount	Deposit Account resource.

Get by Id

Get a deposit account resource by id.

curl -X GET 'https://api.s.unit.sh/accounts/42' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/accounts/{id}`
Required Scope	`accounts`

Query Parameters

Name	Type	Default	Description
include	string	(empty)	Optional. Related resource available to include: `customer`. See Getting Related Resources

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	DepositAccount	The requested resource after the operation was completed.
included	Array of Customer	Array of resources requested by the `include` query parameter.

List

List deposit account resources. Paging can be applied.

curl -X GET 'https://api.s.unit.sh/accounts?page[limit]=20&page[offset]=10' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/accounts`
Required Scope	`accounts`

Query Parameters

Name	Type	Default	Description
page[limit]	integer	100	Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
page[offset]	integer	0	Number of resources to skip. See Pagination.
filter[customerId]	string	(empty)	Optional. Filters the results by the specified customer id.
filter[tags]	Tags (JSON)	(empty)	Optional. Filter Accounts by Tags.
include	string	(empty)	Optional. Related resource available to include: `customer`. See Getting Related Resources

Response

Example Response:

{
  "data": [
    {
      "type": "depositAccount",
      "id": "42",
      "attributes": {
        "createdAt": "2000-05-11T10:19:30.409Z",
        "name": "Peter Parker",
        "status": "Open",
        "depositProduct": "checking",
        "routingNumber": "812345678",
        "accountNumber": "1000000002",
        "currency": "USD",
        "balance": 10000,
        "hold": 0,
        "available": 10000,
        "tags": {
          "purpose": "tax"
        }
      },
      "relationships": {
        "customer": {
          "data": {
            "type": "customer",
            "id": "45555"
          }
        }
      }
    }
  ]
}

Response is a JSON:API document.

200 OK

Field	Type	Description
data	Array of DepositAccount	Array of deposit account resources.
included	Array of Customer	Array of resources requested by the `include` query parameter.

Update

Example Request:

Update a deposit account.

{
  "data": {
    "type": "depositAccount",
    "attributes": {
      "tags": {
        "purpose": "Tax",
        "trackUserId": null,
        "newTag": "New tag value"
      }
    }
  }
}

Verb	`PATCH`
Url	`https://api.s.unit.sh/accounts/:accountId`
Required Scope	`depositAccount`

Attributes

Name	Type	Description
tags	object	See Updating Tags.

Response

Response is a JSON:API document.

Example Response:

{
  "data": {
    "type": "depositAccount",
    "id": "42",
    "attributes": {
      "createdAt": "2000-05-11T10:19:30.409Z",
      "name": "Peter Parker",
      "status": "Open",
      "depositProduct": "checking",
      "routingNumber": "812345678",
      "accountNumber": "1000000002",
      "currency": "USD",
      "balance": 10000,
      "hold": 0,
      "available": 10000,
      "tags": {
        "purpose": "checking"
      }
    },
    "relationships": {
      "customer": {
        "data": {
          "type": "customer",
          "id": "45555"
        }
      }
    }
  }
}

200 OK

Field	Type	Description
data	DepositAccount	The requested resource after the operation was completed.

Limits

curl -X GET 'https://api.s.unit.sh/accounts/10104/limits' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/accounts/:accountId/limits`

Example Response

{
  "data": {
    "type": "limits",
    "attributes": {
      "ach": {
        "limits": {
          "dailyDebit": 50000,
          "dailyCredit": 50000,
          "monthlyDebit": 2000000,
          "monthlyCredit": 2000000
        },
        "totalsDaily": {
          "debits": 25000,
          "credits": 10000
        },
        "totalsMonthly": {
          "debits": 800300,
          "credits": 250000
        }
      },
      "card": {
        "limits": {
          "dailyWithdrawal": 500000,
          "dailyDeposit": 500000,
          "dailyPurchase": 500000
        },
        "totalsDaily": {
          "withdrawals": 25000,
          "deposits": 0,
          "purchases": 12500
        }
      }
    }
  }
}

Monetary transactions (such as originating ACH payments, ATM withdrawals or deposits) are subjected to daily and monthly amount limits. Once the limit is reached, the transaction will be rejected. The limits are determined by us and are set in the terms configured in your account’s deposit product. You may contact Unit to change the limits for an account or a group of accounts.

The daily limits are reset at 7:00 p.m. EST. The monthly limits are reset on the first of each month. We provide an API to query the current limits (and daily/monthly totals) for your account.

Get Account Balance History

List account end-of-day balances history (filtering and paging can be applied).

The account balance history can be used to provide the customer with an overview of their balance across account(s) over time in a visually engaging way, providing insights and creating custom product features around it.

curl -X GET 'https://api.s.unit.sh/account-end-of-day?page[limit]=10&page[offset]=0&filter[customerId]=10000&filter[accountId]=30317&filter[since]=2020-10-11&filter[until]=2021-10-13' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/account-end-of-day`
Required Scope	`account-end-of-day`

Query Parameters

Name	Type	Default	Description
page[limit]	integer	100	Maximum number of resources that will be returned. Maximum is 1000 resources.
page[offset]	integer	0	Number of resources to skip.
filter[accountId]	string	(empty)	Optional. Filters the results by the specified account id.
filter[customerId]	string	(empty)	Optional. Filters the results by the specified customer id.
filter[since]	ISO Local Date string	(empty)	Optional. Filters the account end-of-day balances before the specified date. e.g. `2021-06-01`
filter[until]	ISO Local Date string	(empty)	Optional. Filters the account end-of-day balances after the specified date. e.g. `2021-07-01`

Response

Example Response:

{
  "data": [
    {
      "type": "accountEndOfDay",
      "id": "4925158",
      "attributes": {
        "date": "2021-07-10",
        "balance": 1000,
        "available": 500,
        "hold": 500
      },
      "relationships": {
        "customer": {
          "data": {
            "type": "customer",
            "id": "10000"
          }
        },
        "account": {
          "data": {
            "type": "account",
            "id": "30317"
          }
        }
      }
    },
    {
      "type": "accountEndOfDay",
      "id": "4925158",
      "attributes": {
        "date": "2021-07-11",
        "balance": 1000,
        "available": 500,
        "hold": 500
      },
      "relationships": {
        "customer": {
          "data": {
            "type": "customer",
            "id": "10000"
          }
        },
        "account": {
          "data": {
            "type": "account",
            "id": "30317"
          }
        }
      }
    }
  ]
}

Response is a JSON:API document.

200 OK

Field	Type	Description
data	Array of Account End-Of-Day	Array of account end-of-day resources.

Payments

Unit allows you to originate and receive ACH payments from/to all deposit accounts. For general information on the ACH network, we recommend the following series from Gusto: How ACH Works: a Developer's Perspective.

ACH Origination overview

In Unit, an ACH payment originates from a Deposit Account. The entity on the other side of the payment is called a Counterparty. A counterparty is a combination of routing number, account number, account type, and name.

Each ACH payment has a direction - either Debit or Credit. In the context of ACH payment origination, the directions work as follows:

Debit - the payment “pulls” funds from the counterparty account. The amount is credited to the originating deposit account on Unit. It may take several banking (business) days for the credit to be settled, depending on the settings for your organization.
Credit - the payment “pushes” funds to the counterparty account. The amount is debited from the originating deposit account immediately.

ACH returns are handled by Unit:

When you're on the originating side of an ACH payment, the counterparty's institution may issue a return. This can happen in the case of ACH Debit (example reasons: unauthorized debit, insufficient funds in the counterparty's account) or ACH Credit (example reason: incorrect account number). When such returns happen, the payment.returned webhook event will be fired. In addition, a Returned ACH Transaction will be created within the relevant deposit account, to offset the original transaction associated with the ACH payment.
When you're on receiving side of an ACH payment, Unit may issue a return. This can happen in the case of ACH Debit (example reason: an attempt to debit a deposit account with insufficient funds) or ACH Credit (example reason: an attempt to credit an non-existent account number).

Originating an ACH payment supports Idempotency, to ensure that multiple identical requests will have the same effect as a single request.

ACH payment originations (both Debit and Credit) are subject to daily amount limits determined by the account's deposit product. Once you exceed the account's total daily limit, payments will be created under the Rejected status code, and the relevant API responses will contain the exact reason. You may contact Unit to change the limits for an account or a group of accounts. See the Limits section for more information.

ACH payment to inline Counterparty

Example Request:

curl -X POST 'https://api.s.unit.sh/payments' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data": {
    "type": "achPayment",
      "attributes": {
        "amount": 10000,
        "direction": "Credit",
        "counterparty": {
          "routingNumber": "812345678",
          "accountNumber": "12345569",
          "accountType": "Checking",
          "name": "Jane Doe"
        },
        "description": "Funding"
      },
      "relationships": {
        "account": {
          "data": {
            "type": "depositAccount",
            "id": "555"
          }
      }
    }
  }
}'

Originates an ACH payment to a counterparty which is specified inline (vs to a linked Counterparty Resource).

Verb	`POST`
Url	`https://api.s.unit.sh/payments`
Required Scope	`payments-write` or `payments-write-ach-debit`
Data Type	`achPayment`

You can use scope payments-write-ach-debit only with ACH Debit payments.

Attributes

Name	Type	Description
amount	integer	The amount (in cents).
direction	string	The direction in which the funds flow.
counterparty	Counterparty	The party on the other side of the ACH payment.
description	string	Payment description (maximum of 10 characters), also known as Company Entry Description, this will show up on statement of the counterparty.
addenda	string	Optional, additional payment description (maximum of 50 characters), not all institutions present that.
idempotencyKey	string	See Idempotency.
tags	object	See Tags. Tags that will be copied to any transaction that this payment creates (see Tag Inheritance).

Relationships

Name	Type	Description
account	JSON:API Relationship	The Deposit Account originating the payment.

Response

Example Response:

{
  "data": {
    "type": "achPayment",
    "id": "50",
    "attributes": {
      "createdAt": "2020-01-13T16:01:19.346Z",
      "status": "Pending",
      "reason": null,
      "counterparty": {
        "routingNumber": "812345678",
        "accountNumber": "12345569",
        "accountType": "Checking",
        "name": "Jane Doe"
      },
      "description": "Funding",
      "direction": "Credit",
      "amount": 10000,
      "tags" : {
        "purpose": "internal"
      }
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "555"
        }
      },
      "customer": {
        "data": {
          "type": "individualCustomer",
          "id": "99823"
        }
      }
    }
  }
}

Response is a JSON:API document.

ACH payment to linked Counterparty

Example Request:

curl -X POST 'https://api.s.unit.sh/payments' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data": {
    "type": "achPayment",
    "attributes": {
      "amount": 10000,
      "direction": "Credit",
      "description": "Funding"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "555"
        }
      },
      "counterparty": {
        "data": {
          "type": "counterparty",
          "id": "4567"
        }
      }
    }
  }
}'

Originates an ACH payment to a Counterparty. The counterparty should be created separately through Create Counterparty.

Verb	`POST`
Url	`https://api.s.unit.sh/payments`
Required Scope	`payments-write-counterparty` or `payments-write`
Data Type	`achPayment`

Attributes

Name	Type	Description
amount	integer	The amount (in cents).
direction	string	The direction in which the funds flow.
description	string	Payment description (maximum of 10 characters), also known as Company Entry Description, this will show up on statement of the counterparty.
addenda	string	Optional, additional payment description (maximum of 50 characters), not all institutions present that.
idempotencyKey	string	See Idempotency.
tags	object	See Tags. Tags that will be copied to any transaction that this payment creates (see Tag Inheritance).
verifyCounterpartyBalance	boolean	Optional, default is `false`. Verify the counterparty balance, if balance verification fails the payment will be rejected with reason set to `CounterpartyInsufficientFunds`.

Relationships

Name	Type	Description
account	JSON:API Relationship	The Deposit Account originating the payment.
counterparty	JSON:API Relationship	The Counterparty the payment to be made to.

Response

Example Response:

{
  "data": {
    "type": "achPayment",
    "id": "50",
    "attributes": {
      "createdAt": "2020-01-13T16:01:19.346Z",
      "status": "Pending",
      "reason": null,
      "counterparty": {
        "routingNumber": "812345678",
        "accountNumber": "12345569",
        "accountType": "Checking",
        "name": "Jane Doe"
      },
      "description": "Funding",
      "direction": "Credit",
      "amount": 10000,
      "tags" : {
        "purpose": "internal"
      }
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "555"
        }
      },
      "customer": {
        "data": {
          "type": "individualCustomer",
          "id": "99823"
        }
      },
      "counterparty": {
        "data": {
          "type": "counterparty",
          "id": "4567"
        }
      }
    }
  }
}

Response is a JSON:API document.

ACH payment with Plaid token

Example Request:

curl -X POST 'https://api.s.unit.sh/payments' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data": {
    "type": "achPayment",
    "attributes": {
      "amount": 10000,
      "direction": "Debit",
      "plaidProcessorToken": "processor-5a62q307-ww0a-6737-f6db-pole26004556",
      "description": "Funding"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "555"
        }
      }
    }
  }
} '

Originates an ACH payment to a counterparty which is verified by Plaid.

Verb	`POST`
Url	`https://api.s.unit.sh/payments`
Required Scope	`payments-write` or `payments-write-ach-debit`
Data Type	`achPayment`

Attributes

Name	Type	Description
amount	integer	The amount (in cents)
direction	string	The direction in which the funds flow
description	string	Payment description (maximum of 50 characters)
idempotencyKey	string	See idempotency
counterpartyName	string	Name of the person or company that owns the counterparty bank account.
plaidProcessorToken	string	See Create Plaid processor token API
verifyCounterpartyBalance	boolean	Optional, default is `false`. Verify the counterparty balance, if balance verification fails the payment will be rejected with reason set to `CounterpartyInsufficientFunds`.

Relationships

Name	Type	Description
account	JSON:API Relationship	The Deposit Account originating the payment

Response

Example Response:

{
  "data": {
    "type": "achPayment",
    "id": "50",
    "attributes": {
      "createdAt": "2020-01-13T16:01:19.346Z",
      "status": "Pending",
      "reason": null,
      "counterparty": {
        "routingNumber": "812345678",
        "accountNumber": "12345569",
        "accountType": "Checking",
        "name": "Jane Doe"
      },
      "description": "Funding",
      "direction": "Credit",
      "amount": 10000,
      "tags" : {
        "purpose": "internal"
      }
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "555"
        }
      },
      "customer": {
        "data": {
          "type": "individualCustomer",
          "id": "99823"
        }
      }
    }
  }
}

Response is a JSON:API document.

Receiving an ACH payment

You can receive ACH payments (both Debit and Credit) into any deposit account. To do so, you may provide the routing number and account number to trusted third parties. These numbers are both attributes of any deposit account.

Received ACH payments are processed automatically. You can get notified on them by listening to the transaction.created webhook and inspecting the payload for a received ACH transaction.

Examples:

Receiving an ACH Credit in the amount of $20 when the balance is $0 will automatically result in a balance increase. Two transactions will be created: one received ACH transaction and one associated fee transaction (if the fee is non-zero).
Receiving an ACH Debit in the amount of $20 when the balance is $10 will automatically result in an ACH return to the originating side of the payment. No transactions will be created.

ACH Status

The ACH network operates in batches. When you originate an ACH payment, it will be created with a Pending status. You may track its progress using the status attribute or listening to relevant webhooks, such as payment.sent or payment.returned.

The possible status values are:

Status	Description
`Pending`	The payment was created on the Unit ledger but was not yet delivered to the ACH network. Payments with `Pending` status may be canceled by the originator.
`PendingReview`	The payment is pending review by Unit.
`Rejected`	The payment was rejected due to insufficient funds or exceeding daily ACH limits (see `reason` for more details).
`Clearing`	(Debit only) The payment was sent but the deposit account was not credited yet.
`Sent`	The payment was processed by the ACH network. This is the final state for successful payments.
`Canceled`	The payment was canceled.
`Returned`	The payment was processed but the network or the receiving bank returned the payment (see `reason` for more details).

Create a Book payment

Example Request:

curl -X POST 'https://api.s.unit.sh/payments' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data": {
    "type": "bookPayment",
    "attributes": {
      "amount": 10000,
      "description": "Funding"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "555"
        }
      },
      "counterpartyAccount": {
        "data": {
          "type": "depositAccount",
          "id": "99821"
        }
      }
    }
  }
}'

Book payments are free and instant fund transfers between two accounts under your organization. Common uses for book payments include:

Moving funds between two accounts that belong to the same end-customer.
Moving funds between two accounts that belong to different end-customers.
Moving funds from clearing accounts to end-customer accounts.
Moving funds from your organization's revenue account to an end-customer account.

Once you create a book payment, Unit will process it instantly and free of charge. The result will be one Book Transaction in each account.

The direction of book payment is always Credit, moving funds from account to counterpartyAccount.

Verb	`POST`
Url	`https://api.s.unit.sh/payments`
Required Scope	`payments-write`
Data Type	`bookPayment`

Attributes

Name	Type	Description
amount	integer	The amount (in cents).
description	string	Payment description (maximum of 50 characters), this will show up on statement of the counterparty.
idempotencyKey	string	See Idempotency.
tags	object	See Tags. Tags that will be copied to any transaction that this payment creates (see Tag Inheritance).

Relationships

Name	Type	Description
account	JSON:API Relationship	The Deposit Account originating the payment.
counterpartyAccount	JSON:API Relationship	The Counterparty account the payment to be made to.

Response

Example Response:

{
  "data": {
    "type": "bookPayment",
    "id": "1232",
    "attributes": {
      "createdAt": "2021-02-21T13:03:19.025Z",
      "amount": 1500,
      "direction": "Credit",
      "description": "Funding",
      "status": "Sent"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "account",
          "id": "555"
        }
      },
      "customer": {
        "data": {
          "type": "customer",
          "id": "10000"
        }
      },
      "counterpartyAccount": {
        "data": {
          "type": "account",
          "id": "99821"
        }
      },
      "counterpartyCustomer": {
        "data": {
          "type": "customer",
          "id": "10000"
        }
      },
      "transaction": {
        "data": {
          "type": "transaction",
          "id": "1413"
        }
      }
    }
  }
}

Response is a JSON:API document.

Update ACH Payment

Update an ACH Payment.

Update an ACH payment:

curl -X PATCH 'https://api.s.unit.sh/payments/:paymentId' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type": "achPayment",
    "attributes": {
      "tags": {
        "by": null,
        "uuid": "83033b64-38f8-4dbc-91a1-313ff0156d02"
      }
    }
  }
}'

Verb	`PATCH`
Url	`https://api.s.unit.sh/payments/:paymentId`
Required Scope	`payments-write`

Attributes

Name	Type	Description
tags	object	See Updating Tags.

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	AchPayment	The updated ACH payment resource.

Update Book Payment

Update a Book Payment.

Update book payment:

curl -X PATCH 'https://api.s.unit.sh/payments/:paymentId' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type": "bookPayment",
    "attributes": {
      "tags": {
        "by": null,
        "uuid": "83033b64-38f8-4dbc-91a1-313ff0156d02"
      }
    }
  }
}'

Verb	`PATCH`
Url	`https://api.s.unit.sh/payments/:paymentId`
Required Scope	`payments-write`

Attributes

Name	Type	Description
tags	object	See Updating Tags.

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	BookPayment	The updated Book payment resource.

Receiving a wire payment

You can receive wire (Fedwire) payments into any deposit account. To do so, you may provide the routing number and account number to trusted third parties. These numbers are both attributes of any Deposit Account.

Received wire payments are processed automatically. You can get notified on them by listening to the transaction.created webhook and inspecting the payload for a Wire Transaction.

As an example, receiving a wire payment in the amount of $4,000 when the balance is $0 will automatically result in a balance increase. Two transactions will be created: one Wire Transaction and one associated Fee Transaction (if the fee is non-zero).

Get by Id

Get a payment by id.

curl -X GET 'https://api.s.unit.sh/payments/100' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/payments/{id}`
Required Scope	`payments`

Query Parameters

Name	Type	Default	Description
include	string	(empty)	Optional. A comma-separated list of related resources to include in the response. Related resources include: `customer`, `account`, `transaction`. See Getting Related Resources

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	ACH Payment	Payment resource.
included	Array of DepositAccount or Customer or Transaction	Array of resources requested by the `include` query parameter.

List

List payments resources. Filtering, paging and sorting can be applied.

curl -X GET 'https://api.s.unit.sh/payments?page[limit]=20&page[offset]=10' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/payments`
Required Scope	`payments`

Query Parameters

Name	Type	Default	Description
page[limit]	integer	100	Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
page[offset]	integer	0	Number of resources to skip. See Pagination.
filter[accountId]	string	(empty)	Optional. Filters the results by the specified account id.
filter[customerId]	string	(empty)	Optional. Filters the results by the specified customer id.
filter[tags]	Tags (JSON)	(empty)	Optional. Filter Payments by Tags.
filter[status]	ACH Status (JSON)	(empty)	Optional. Filter Payments by ACH Status.
filter[since]	RFC3339 Date string	(empty)	Optional. Filters the Payments that occurred after the specified date. e.g. `2020-01-13T16:01:19.346Z`
filter[until]	RFC3339 Date string	(empty)	Optional. Filters the Payments that occurred before the specified date. e.g. `2020-01-02T20:06:23.486Z`
sort	string	`sort=-createdAt`	Optional. Leave empty or provide `sort=createdAt` for ascending order. Provide `sort=-createdAt` (leading minus sign) for descending order.
include	string	(empty)	Optional. A comma-separated list of related resources to include in the response. Related resources include: `customer`, `account`, `transaction`. See Getting Related Resources

Response

Example Response:

{
  "data": [
    {
      "type": "achPayment",
      "id": "50",
      "attributes": {
        "createdAt": "2020-01-13T16:01:19.346Z",
        "status": "Pending",
        "counterparty": {
          "routingNumber": "812345678",
          "accountNumber": "12345569",
          "accountType": "Checking",
          "name": "Jane Doe"
        },
        "description": "Funding",
        "direction": "Credit",
        "amount": 10000
      },
      "relationships": {
        "account": {
          "data": {
            "type": "depositAccount",
            "id": "555"
          }
        },
        "customer": {
          "data": {
            "type": "individualCustomer",
            "id": "99823"
          }
        },
        "counterparty": {
          "data": {
            "type": "counterparty",
            "id": "4567"
          }
        },
        "transaction": {
          "data": {
            "type": "transaction",
            "id" : "4003"
          }
        }
      }
    }
  ]
}

Response is a JSON:API document.

200 OK

Field	Type	Description
data	Array of ACH Payment	Array of payment resources.
included	Array of DepositAccount or Customer or Transaction	Array of resources requested by the `include` query parameter.

Payments: Counterparties

The counterparty resource represents the other party that participates in a financial transaction.

When a customer is expected to send funds to same counterparty on multiple occasions you may create a counterparty resource and re-use it by creating an ACH payment to linked Counterparty, instead of the customer typing the routing number and account number repeatedly.

When creating an API Token Unit recommends not to select the payments-write and counterparties-write, however we do recommend selecting payments-write-counterparty scope, which allows making payments to counterparty resource only.

When using the recommended scopes for API Token you would first need to Create a Customer Token (along with two-factor authentication) in order to create the counterparty resource.

The counterparty resource also allows you to make (automated) payments without creating a Customer Token or selecting sensitive scopes for the API Token, by using ACH payment to linked Counterparty and API Token with only payments-write-counterparty selected.

This adds another layer of security, because the API Token alone cannot make payments to counterparties which are not created and approved by the customer.

Create Counterparty

Creates a counterparty for a specific customer.

Example Request:

curl -X POST 'https://api.s.unit.sh/counterparties' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data": {
    "type": "achCounterparty",
    "attributes": {
      "name": "Joe Doe",
      "routingNumber": "011000138",
      "accountNumber": "123",
      "accountType": "Checking",
      "type": "Person"
    },
    "relationships": {
      "customer": {
        "data": {
          "type": "customer",
          "id": "111111"
        }
      }
    }
  }
}'

Verb	`POST`
Url	`https://api.s.unit.sh/counterparties`
Required Scope	`counterparties-write`
Data Type	`achCounterparty`

Attributes

Name	Type	Description
name	string	The account holder's name (whether an individual or a business).
routingNumber	string	Valid 9-digit ABA routing transit number.
accountNumber	string	Bank account number.
accountType	string	Either `Checking` or `Savings`.
type	string	Either `Business`, `Person` or `Unknown`.

Relationships

Name	Type	Description
customer	JSON:API Relationship	The customer that the counterparty belongs to.

Response

Response is a JSON:API document.

Example Response:

{
  "data": {
    "type": "achCounterparty",
    "id": "8",
    "attributes": {
      "createdAt": "2020-05-13T09:07:47.645Z",
      "name": "Joe Doe",
      "routingNumber": "011000138",
      "bank": "Bank Of America",
      "accountNumber": "123",
      "accountType": "Checking",
      "type": "Person",
      "permissions": "CreditOnly"
    },
    "relationships": {
      "customer": {
        "data": {
          "type": "customer",
          "id": "111111"
        }
      }
    }
  }
}

201 Created

Field	Type	Description
data	ACH Counterparty	The target resource after the operation was completed.

Create Counterparty with Plaid token

Creates a counterparty for a specific customer

Example Request:

curl -X POST 'https://api.s.unit.sh/counterparties' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
    "data": {
      "type": "achCounterparty",
      "attributes": {
        "name": "Sherlock Holmes",
        "plaidProcessorToken": "processor-5a62q307-ww0a-6737-f6db-pole26004556",
        "type": "Person"
      },
      "relationships": {
        "customer": {
          "data": {
            "type": "customer",
            "id": "111111"
          }
        }
      }
    }
  }'

Verb	`POST`
Url	`https://api.s.unit.sh/counterparties`
Required Scope	`counterparties-write`
Data Type	`achCounterparty`

Attributes

Name	Type	Description
type	string	Either `Business`, `Person` or `Unknown`
name	string	The account holder's name (whether an individual or a business).
plaidProcessorToken	string	Plaid integration token See Plaid processor token
verifyName	boolean	Optional, default to false. Verify the name of the counterparty, if the name verification fails the request will fail with `code` field set to `NameVerificationFailed`.

Unit is using a fuzzy name-match algorithm for name verification, which is not always accurate, because of that we include the counterparty account owners in the error returned under meta.owners. You can use that information to implement a manual review process.

Relationships

Name	Type	Description
customer	JSON:API Relationship	The customer that the counterparty belongs to.

Delete

Delete a counterparty resource by id.

curl -X DELETE 'https://api.s.unit.sh/counterparties/1' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`DELETE`
Url	`https://api.s.unit.sh/counterparties/{id}`
Required Scope	`counterparties`

Response

204 No Content

Get by Id

Get a counterparty resource by id.

curl -X GET 'https://api.s.unit.sh/counterparties/:counterpartyId' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/counterparties/{id}`
Required Scope	`counterparties`

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	ACH Counterparty	Counterparty resource.

List

List counterparties. Filtering and paging can be applied.

curl -X GET 'https://api.s.unit.sh/counterparties?page[limit]=20&page[offset]=0' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/counterparties`
Required Scope	`counterparties`

Query Parameters

Name	Type	Default	Description
page[limit]	integer	100	Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
page[offset]	integer	0	Number of resources to skip. See Pagination.
filter[customerId]	string	(empty)	Optional. Filters the results by the specified customer id.

Response

Example Response:

{
  "data": [
    {
      "type": "achCounterparty",
      "id": "8",
      "attributes": {
        "createdAt": "2020-05-13T09:07:47.645Z",
        "name": "Joe Doe",
        "routingNumber": "123456789",
        "accountNumber": "123",
        "accountType": "Checking",
        "type": "Person",
        "permissions": "CreditOnly"
      },
      "relationships": {
        "customer": {
          "data": {
            "type": "customer",
            "id": "111111"
          }
        }
      }
    }
  ]
}

Response is a JSON:API document.

200 OK

Field	Type	Description
data	Array of ACH Counterparty	Array of counterparty resources.

Update Counterparty

Update a Counterparty. Relink existing counterparty with a new Plaid processor token.

Update a counterparty:

curl -X PATCH 'https://api.s.unit.sh/counterparties/:counterpartyId' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data": {
    "type": "counterparty",
    "attributes": {
      "plaidProcessorToken": "processor-sandbox-b14ad1fd-3398-46a8-a316-5bf574fc2459"
    }
  }
}'

Verb	`PATCH`
Url	`https://api.s.unit.sh/counterparties/:counterpartyId`

Attributes

Name	Type	Description
plaidProcessorToken	string	Plaid integration token See Plaid processor token
verifyName	boolean	Optional, default to false. Verify the name of the counterparty, if the name verification fails the request will fail with `code` field set to `NameVerificationFailed`.

Response

Response is a JSON:API document.

200 OK

Example Response:

{
  "data": {
    "type": "achCounterparty",
    "id": "8",
    "attributes": {
      "createdAt": "2020-05-13T09:07:47.645Z",
      "name": "Joe Doe",
      "routingNumber": "011000138",
      "bank": "Bank Of America",
      "accountNumber": "123",
      "accountType": "Checking",
      "type": "Person",
      "permissions": "CreditOnly"
    },
    "relationships": {
      "customer": {
        "data": {
          "type": "customer",
          "id": "111111"
        }
      }
    }
  }
}

Field	Type	Description
data	ACH Counterparty	The target resource after the operation was completed.

Account Funding

Account Funding - allowing a customer that just created an account to fund his new account using an external account (account within another bank or institution) owned by the customer.

Unit supports Account Funding by creating a counterparty with Plaid Processor Token and then creating an ACH Debit Payment.

Verifying the identity and balance

Because Account Funding is high risk, Unit recommends that you would verify the identity and balance of the counterparty using Plaid. Unit supports both of those operations:

Identity - specify true for the verifyName field when creating the counterparty, Unit would use Plaid Identity and a fuzzy name match algorithm to verify the name of the counterparty.
Balance - specify true for the verifyCounterpartyBalance field when creating the payment, Unit would use Plaid to verify that the counterparty account has sufficient funds.

How To Fund an Account

Use Plaid Link to allow the customer to provide the account for Account Funding.
Exchange the access token to Unit's processor token.
Create a counterparty with the processor token, name set to the customer name and the verifyName set to true.
Create an ACH Debit Payment, set the verifyCounterpartyBalance to true.
Wait for the payment to be cleared.

Payments: Returns

Return Received ACH Transaction

Returns a Received ACH transaction with a specified ACH Return Reason.

Returning a Received ACH transaction creates a Returned Received ACH transaction, posting the funds immediately in the opposite direction.

Example Request:

Update Transaction

{
  "data": {
    "type": "returnAch",
    "attributes": {
      "reason": "Unauthorized"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "13052"
        }
      }
    }
  }
}

Verb	`POST`
Url	`https://api.s.unit.sh/returns/:transactionId`
Data Type	`returnAch`

Attributes

Name	Type	Description
reason	string	The ACH Return Reason for returning the transaction.

Relationships

Field	type	Description
account	JSON:API Relationship	The Deposit Account of the customer.

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	ReturnedReceivedAchTransaction	Transaction resource.

ACH Return Reasons

The following reasons can be used to initiate a return of a received ACH transaction:

Type	Short Description
`Unauthorized`	Account is not authorized to receive the funds

Cards

The Card resource represents a debit card under an account.

Card creation request supports Idempotency, ensuring that performing multiple identical requests will have the same effect as performing a single request.

Card Statuses

Card have a Status Property, which represent their current status and determines what actions can or can't be completed using the card.

Status	Description
Inactive	The Card has not been activated by the Customer
Active	The Card has been activated and can be used regularly
Stolen	The Card has been reported stolen by the Customer
Lost	The Card has been reported lost by the customer, and cannot be reopened
Frozen	The Card has been frozen
ClosedByCustomer	The Card has been closed by the Customer
SuspectedFraud	The Card has been flagged due to fraud suspicion

Create Individual Debit Card

Creates and ships a physical debit card to an individual. You must link the card to an account using the account field under relationships object. The linked account must belong to an individual customer (and not a business).

Example Request:

curl -X POST 'https://api.s.unit.sh/cards' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type":"individualDebitCard",
    "attributes": {
      "shippingAddress": {
        "street": "5230 Newell Rd",
        "street2": null,
        "city": "Palo Alto",
        "state": "CA",
        "postalCode": "94303",
        "country": "US"
      },
      "idempotencyKey": "3a1a33be-4e12-4603-9ed0-820922389fb8"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "2"
        }
      }
    }
  }
}'

Verb	`POST`
Url	`https://api.s.unit.sh/cards`
Required Scope	`cards-write`
Data Type	`individualDebitCard`

Attributes

Name	Type	Description
shippingAddress	Address	Address to ship the card to. Optional, if not specified, the individual address is used.
design	string	Optional. You may omit if you only have one card design. Please contact Unit if you need multiple card designs.
idempotencyKey	string	See Idempotency.
tags	object	See Tags.

Relationships

Name	Type	Description
account	JSON:API Relationship	Link to the account the card belongs to. Holder of the account must be an individual.

Response

Response is a JSON:API document.

Example Response:

{
  "data": {
    "type": "individualDebitCard",
    "id": "8",
    "attributes": {
      "createdAt": "2020-05-13T09:07:47.645Z",
      "last4Digits": "1234",
      "expirationDate": "2022-05",
      "shippingAddress": {
        "street": "5230 Newell Rd",
        "street2": null,
        "city": "Palo Alto",
        "state": "CA",
        "postalCode": "94303",
        "country": "US"
      },
      "status": "Inactive"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "2"
        }
      },
      "customer": {
        "data": {
          "type": "individualCustomer",
          "id": "2"
        }
      }
    }
  }
}

201 Created

Field	Type	Description
data	IndividualDebitCard	The target resource after the operation was completed.

Create Business Debit Card

Creates and ships a physical debit card to a business card holder. You must link the card to an account using the account field under relationships object. The linked account must belong to a business customer.

Example Request:

curl -X POST 'https://api.s.unit.sh/cards' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type":"businessDebitCard",
    "attributes": {
      "shippingAddress": {
        "street": "5230 Newell Rd",
        "street2": null,
        "city": "Palo Alto",
        "state": "CA",
        "postalCode": "94303",
        "country": "US"
      },
      "fullName": {
        "first": "Richard",
        "last": "Hendricks"
      },
      "ssn": "123456789",
      "address": {
        "street": "5230 Newell Rd",
        "street2": null,
        "city": "Palo Alto",
        "state": "CA",
        "postalCode": "94303",
        "country": "US"
      },
      "dateOfBirth": "2001-08-10",
      "email": "richard@piedpiper.com",
      "phone": {
        "countryCode": "1",
        "number": "5555555555"
      },
      "idempotencyKey": "3a1a33be-4e12-4603-9ed0-820922389fb8"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "1"
        }
      }
    }
  }
}'

Verb	`POST`
Url	`https://api.s.unit.sh/cards`
Required Scope	`cards-write`
Data Type	`businessDebitCard`

Attributes

Name	Type	Description
shippingAddress	Address	Address to ship the card to. Optional, if not specified, card holder address is used.
ssn	string	SSN of the card holder (numbers only). Either an SSN or a passport number is required.
passport	string	Passport number of the card holder. Either an SSN or a passport is required.
nationality	ISO31661-Alpha2 string	Required on passport only. Two letters representing the card holder nationality. (e.g. “US”).
fullName	FullName	Full name of the card holder.
dateOfBirth	RFC3339 Date string	Date of birth of the card holder (e.g. `"2001-08-15"`).
address	Address	Address of the card holder.
phone	Phone	Phone of the card holder.
email	string	Email address of the card holder.
design	string	Optional. You may omit if you only have one card design. Please contact Unit if you need multiple card designs.
idempotencyKey	string	See Idempotency.
tags	object	See Tags.

Relationships

Name	Type	Description
account	JSON:API Relationship	The account the card belongs to. Holder of the account must be a business.

Response

Response is a JSON:API document.

Example Response:

{
  "data": {
    "type": "businessDebitCard",
    "id": "9",
    "attributes": {
      "createdAt": "2020-05-13T09:42:21.857Z",
      "last4Digits": "2074",
      "expirationDate": "2022-05",
      "shippingAddress": {
        "street": "5230 Newell Rd",
        "street2": null,
        "city": "Palo Alto",
        "state": "CA",
        "postalCode": "94303",
        "country": "US"
      },
      "address": {
        "street": "5230 Newell Rd",
        "street2": null,
        "city": "Palo Alto",
        "state": "CA",
        "postalCode": "94303",
        "country": "US"
      },
      "fullName": {
        "first": "Richard",
        "last": "Hendricks"
      },
      "phone": {
        "countryCode": "1",
        "number": "5555555666"
      },
      "email": "richard@piedpiper.com",
      "dateOfBirth": "2001-08-10",
      "ssn": "123456789",
      "status": "Inactive"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "1"
        }
      },
      "customer": {
        "data": {
          "type": "businessCustomer",
          "id": "1"
        }
      }
    }
  }
}

201 Created

Field	Type	Description
data	BusinessDebitCard	The target resource after the operation was completed.

Create Individual Virtual Debit Card

Creates a debit card for an individual. You must link the card to an account using the account field under relationships object. The linked account must belong to an individual customer (and not a business).

Unlike physical cards, virtual cards are created in Active status and do not require activation.

Example Request:

curl -X POST 'https://api.s.unit.sh/cards' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type":"individualVirtualDebitCard",
    "attributes": {
      "idempotencyKey": "3a1a33be-4e12-4603-9ed0-820922389fb8"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "2"
        }
      }
    }
  }
}'

Verb	`POST`
Url	`https://api.s.unit.sh/cards`
Required Scope	`cards-write`
Data Type	`individualVirtualDebitCard`

Attributes

Name	Type	Description
idempotencyKey	string	See Idempotency.
tags	object	See Tags.

Relationships

Name	Type	Description
account	JSON:API Relationship	Link to the account the card belongs to. Holder of the account must be an individual.

Response

Response is a JSON:API document.

Example Response:

{
  "data": {
    "type": "individualVirtualDebitCard",
    "id": "8",
    "attributes": {
      "createdAt": "2020-05-13T09:07:47.645Z",
      "last4Digits": "1234",
      "expirationDate": "2022-05",
      "status": "Active"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "2"
        }
      },
      "customer": {
        "data": {
          "type": "individualCustomer",
          "id": "2"
        }
      }
    }
  }
}

201 Created

Field	Type	Description
data	IndividualVirtualDebitCard	The target resource after the operation was completed.

Create Business Virtual Debit Card

Creates a debit card for a business. You must link the card to an account using the account field under relationships object. The linked account must belong to a business customer.

Unlike physical cards, virtual cards are created in Active status and do not require activation.

Example Request:

curl -X POST 'https://api.s.unit.sh/cards' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type":"businessVirtualDebitCard",
    "attributes": {
      "fullName": {
        "first": "Richard",
        "last": "Hendricks"
      },
      "ssn": "123456789",
      "address": {
        "street": "5230 Newell Rd",
        "street2": null,
        "city": "Palo Alto",
        "state": "CA",
        "postalCode": "94303",
        "country": "US"
      },
      "dateOfBirth": "2001-08-10",
      "email": "richard@piedpiper.com",
      "phone": {
        "countryCode": "1",
        "number": "5555555555"
      },
      "idempotencyKey": "3a1a33be-4e12-4603-9ed0-820922389fb8"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "1"
        }
      }
    }
  }
}'

Verb	`POST`
Url	`https://api.s.unit.sh/cards`
Required Scope	`cards-write`
Data Type	`businessVirtualDebitCard`

Attributes

Name	Type	Description
ssn	string	SSN of the card holder (numbers only). Either an SSN or a passport number is required.
passport	string	Passport number of the card holder. Either an SSN or a passport is required.
nationality	ISO31661-Alpha2 string	Required on passport only. Two letters representing the card holder nationality. (e.g. “US”).
fullName	FullName	Full name of the card holder.
dateOfBirth	RFC3339 Date string	Date of birth of the card holder (e.g. `"2001-08-15"`).
address	Address	Address of the card holder.
phone	Phone	Phone of the card holder.
email	string	Email address of the card holder.
idempotencyKey	string	See Idempotency.
tags	object	See Tags.

Relationships

Name	Type	Description
account	JSON:API Relationship	The account the card belongs to. Holder of the account must be a business.

Response

Response is a JSON:API document.

Example Response:

{
  "data": {
    "type": "businessVirtualDebitCard",
    "id": "9",
    "attributes": {
      "createdAt": "2020-05-13T09:42:21.857Z",
      "last4Digits": "2074",
      "expirationDate": "2022-05",
      "address": {
        "street": "5230 Newell Rd",
        "street2": null,
        "city": "Palo Alto",
        "state": "CA",
        "postalCode": "94303",
        "country": "US"
      },
      "fullName": {
        "first": "Richard",
        "last": "Hendricks"
      },
      "phone": {
        "countryCode": "1",
        "number": "5555555666"
      },
      "email": "richard@piedpiper.com",
      "dateOfBirth": "2001-08-10",
      "ssn": "123456789",
      "status": "Active"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "1"
        }
      },
      "customer": {
        "data": {
          "type": "businessCustomer",
          "id": "1"
        }
      }
    }
  }
}

201 Created

Field	Type	Description
data	BusinessVirtualDebitCard	The target resource after the operation was completed.

Displaying Sensitive Card Data

In order to display sensitive data (e.g. card number and CVV2) to a customer, without any of it passing through your systems (which requires PCI compliance), Unit utilizes a 3rd party service called Very Good Security or VGS for short.

VGS provides a JavaScript library (as well as iOS and Android SDKs) called VGS Show which allows easy integration with your UI components. VGS Show offloads the PCI compliance burden by enabling the encrypted transmission of sensitive card data from VGS directly to your cardholder.

The VGS Show JavaScript library enables you to securely display sensitive data in a webpage while safely isolating that sensitive data from your systems. VGS Show JavaScript library injects a secure iframe into your HTML. VGS hosts both the iframe, and the data on secure, compliant servers.

Integration steps

Example of creating a Customer Token for sensitive data:

curl -X POST 'https://api.s.unit.sh/customers/8/token' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type":"customerToken",
    "attributes": {
      "scope": "cards-sensitive",
      "verificationToken": "i8FWKLBjXEg3TdeK93G3K9PKLzhbT6CRhn/VKkTsm....",
      "verificationCode": "203130"
    }
  }
}
'

Example of displaying card number and CVV2:

<!DOCTYPE html>
<html>
<head>
    <meta charSet="utf-8">
    <title></title>
    <style>
        iframe {
            height: 20px;
        }
    </style>
</head>
<body>
<h2>Sensitive Data example</h2>
<label>Card Number:</label>
<div id="pan"></div>
<label>CVV2:</label>
<div id="cvv2"></div>

<script type="text/javascript" src="https://js.verygoodvault.com/vgs-show/1.3/ACh8JJTM42LYxwe2wfGQxwj5.js"></script>
<script type="text/javascript">
    const show = VGSShow.create('tntazhyknp1');
    const customerToken = "<CUSTOMER TOKEN>"

    const cvv2iframe = show.request({
            name: 'data-text',
            method: 'GET',
            path: '/cards/<CARD ID>/secure-data/cvv2',
            headers: {
                "Authorization": "Bearer " + customerToken
            },
            htmlWrapper: 'text',
            jsonPathSelector: 'data.attributes.cvv2'
        });
    cvv2iframe.render('#cvv2');

    const paniframe = show.request({
            name: 'data-text',
            method: 'GET',
            path: '/cards/<CARD ID>/secure-data/pan',
            headers: {
                "Authorization": "Bearer " + customerToken
            },
            htmlWrapper: 'text',
            jsonPathSelector: 'data.attributes.pan'
        });
    paniframe.render('#pan');
</script>
</body>
</html>

Import the VGS Show library:

<script type="text/javascript" src="https://js.verygoodvault.com/vgs-show/1.3/ACh8JJTM42LYxwe2wfGQxwj5.js"></script>

Initialize the component:

const show = VGSShow.create('tntazhyknp1');

The Vault Id tntazhyknp1 enables you to test your code in a sandbox environment. Contact Unit for the live Vault Id.

Provide a valid customer token:

const customerToken = "<CUSTOMER TOKEN>"

For instructions, see Create Customer Token.

Provide a valid card identifier

path: '/cards/<CARD ID>/secure-data/cvv2'

Additional resources

SDKs for iOS and Android and additional code examples can be found here.

Activate Card

In order to activate a new card, without any sensitive data passing through your systems (which requires PCI compliance), Unit utilizes a 3rd party service called Very Good Security or VGS for short.

VGS provides a JavaScript library (as well as iOS and Android SDKs) called VGS Collect which allows easy integration with your UI components. VGS Collect offloads the PCI compliance burden by enabling the encrypted transmission of sensitive card data from VGS directly to the card processor.

VGS Collect JavaScript library injects a secure iframe into your HTML. VGS hosts both the iframe, and the data on secure, compliant servers.

Unlike physical cards, virtual cards are created in Active status and do not require activation.

Integration steps

Example of creating a Customer Token for Activate Card:

curl -X POST 'https://api.s.unit.sh/customers/8/token' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type":"customerToken",
    "attributes": {
      "scope": "cards-sensitive-write",
      "verificationToken": "i8FWKLBjXEg3TdeK93G3K9PKLzhbT6CRhn/VKkTsm....",
      "verificationCode": "203130"
    }
  }
}
'

Example of Activate Card:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>VGS Collect Credit Card Example</title>

    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/css/bootstrap.min.css"
          integrity="sha384-Gn5384xqQ1aoWXA+058RXPxPg6fy4IWvTNh0E263XmFcJlSAwiGgFAW/dAiS6JXm" crossorigin="anonymous">

    <script type="text/javascript" src="https://js.verygoodvault.com/vgs-collect/2.9.0/vgs-collect.js"></script>

    <style>
        body {
            padding: 25px;
        }

        span[id*="cc-"] {
            display: block;
            height: 40px;
            margin-bottom: 15px;
        }

        span[id*="cc-"] iframe {
            height: 100%;
            width: 100%;
        }

        pre {
            font-size: 12px;
        }

        .form-field {
            display: block;
            width: 100%;
            height: calc(2.25rem + 2px);
            padding: .375rem .75rem;
            font-size: 1rem;
            line-height: 1.5;
            color: #495057;
            background-color: #fff;
            background-clip: padding-box;
            border: 1px solid #ced4da;
            border-radius: .25rem;
            transition: border-color .15s ease-in-out,box-shadow .15s ease-in-out;
        }

        .form-field iframe {
            border: 0 none transparent;
            height: 100%;
            vertical-align: middle;
            width: 100%;
        }

        p {
            margin-bottom: 10px;
        }
    </style>
</head>
<body>
<main>
    <div class="row">
        <div class="col-md-4"></div>
        <div class="col-md-4">
            <div class="row card card-outline-secondary">
                <div class="card-body">
                    <h3 class="text-center">Activate Card</h3>
                    <hr>
                    <div class="alert alert-info p-2">
                        Please fill in and submit the form
                    </div>
                    <form id="cc-form">
                        <div class="form-group">
                            <label for="cc-cvv2">CVV2</label>
                            <span id="cc-cvv2" class="form-field">
                  <!--VGS Collect iframe for CVV2 field will be here!-->
                </span>
                            <label for="cc-expiration-date">Expiration Date</label>
                            <span id="cc-expiration-date" class="form-field">
                  <!--VGS Collect iframe for Expiration Date field will be here!-->
                </span>
                        </div>
                        <!--Submit form button-->
                        <button type="submit" class="btn btn-success btn-block">Submit</button>
                    </form>
                </div>
            </div>
        </div>
        <div class="col-md-4"></div>
    </div>
</main>

<!--Include script with VGS Collect form initialization-->
<script>
    // VGS Collect form initialization
    const form = VGSCollect.create("tntazhyknp1", "sandbox", function(state) {});
    const customerToken = "<CUSTOMER TOKEN>"

    form.field('#cc-cvv2', {
        type: 'card-security-code',
        name: 'data.attributes.cvv2',
        successColor: '#4F8A10',
        errorColor: '#D8000C',
        placeholder: '123',
        maxLength: 3,
        validations: ['required', 'validCardSecurityCode']
    });

    form.field('#cc-expiration-date', {
        type: 'card-expiration-date',
        name: 'data.attributes.expirationDate',
        successColor: '#4F8A10',
        errorColor: '#D8000C',
        placeholder: 'MM / YYYY',
        validations: ['required', 'validCardExpirationDate'],
        // Change to required experiation date format
        serializers: [form.SERIALIZERS.replace('(\\d{2})\\s\\/\\s(\\d{4})', '$2-$1')]
    });

    // Submit by executing a POST request.
    document.getElementById('cc-form')
        .addEventListener('submit', function(e) {
            e.preventDefault();
            form.submit('/cards/<CARD ID>/activate',
                {
                    // This converts the dot-separated field name strings into a JSON object
                    mapDotToObject: 'true',
                    headers: {
                        "Content-Type": "application/vnd.api+json",
                        "Authorization": "Bearer " + customerToken
                    }
                },


                function(status, data) {
                    console.log(data);
                });
        }, function (errors) {
            console.log(errors);
        });
</script>
</body>
</html>

Import the VGS Collect library: <script type="text/javascript" src="https://js.verygoodvault.com/vgs-collect/2.9.0/vgs-collect.js"></script>

Initialize the component:

const form = VGSCollect.create("tntazhyknp1", "sandbox", function(state) {});

The Vault Id tntazhyknp1 enables you to test your code in a sandbox environment. Contact Unit for the live Vault Id.

Provide a valid customer token:

const customerToken = "<CUSTOMER TOKEN>"

For instructions, see Create Customer Token.

Provide a valid card identifier:

path: '/cards/<CARD ID>/activate'

Required field names and formats:

CVV2 field name should be data.attributes.cvv2.
Expiration Date field name should be data.attributes.expirationDate.
Expiration Date field format should be YYYY-MM.

Testing on Sandbox:

To simulate the scenario where the customer provides invalid data - send 1970-01 as the expiration date.
Sending anything other than that will result in a successful card activation.

Additional resources

SDKs for iOS and Android and additional code examples can be found here.

Get PIN Status

Gets the PIN status for the specified card.

If the returned status is NotSet, use Set PIN, otherwise use Change PIN.

curl -X GET 'https://api.s.unit.sh/cards/5/secure-data/pin/status' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/cards/{id}/secure-data/pin/status`
Required Scope	`cards-sensitive`

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	PinStatus	PinStatus resource.

Set PIN

In order to set a new PIN, without any sensitive data passing through your systems (which requires PCI compliance), Unit utilizes a 3rd party service called Very Good Security or VGS for short.

VGS Collect JavaScript library injects a secure iframe into your HTML. VGS hosts both the iframe, and the data on secure, compliant servers.

Integration steps

Example of creating a Customer Token for Set PIN:

curl -X POST 'https://api.s.unit.sh/customers/8/token' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type":"customerToken",
    "attributes": {
      "scope": "cards-sensitive-write",
      "verificationToken": "i8FWKLBjXEg3TdeK93G3K9PKLzhbT6CRhn/VKkTsm....",
      "verificationCode": "203130"
    }
  }
}
'

Example of Set PIN:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Set PIN Example</title>

    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/css/bootstrap.min.css"
          integrity="sha384-Gn5384xqQ1aoWXA+058RXPxPg6fy4IWvTNh0E263XmFcJlSAwiGgFAW/dAiS6JXm" crossorigin="anonymous">

    <script type="text/javascript" src="https://js.verygoodvault.com/vgs-collect/2.9.0/vgs-collect.js"></script>

    <style>
        body {
            padding: 25px;
        }

        span[id*="cc-"] {
            display: block;
            height: 40px;
            margin-bottom: 15px;
        }

        span[id*="cc-"] iframe {
            height: 100%;
            width: 100%;
        }

        pre {
            font-size: 12px;
        }

        .form-field {
            display: block;
            width: 100%;
            height: calc(2.25rem + 2px);
            padding: .375rem .75rem;
            font-size: 1rem;
            line-height: 1.5;
            color: #495057;
            background-color: #fff;
            background-clip: padding-box;
            border: 1px solid #ced4da;
            border-radius: .25rem;
            transition: border-color .15s ease-in-out,box-shadow .15s ease-in-out;
        }

        .form-field iframe {
            border: 0 none transparent;
            height: 100%;
            vertical-align: middle;
            width: 100%;
        }

        p {
            margin-bottom: 10px;
        }
    </style>
</head>
<body>
<main>
    <div class="row">
        <div class="col-md-4"></div>
        <div class="col-md-4">
            <div class="row card card-outline-secondary">
                <div class="card-body">
                    <h3 class="text-center">Set PIN</h3>
                    <hr>
                    <div class="alert alert-info p-2">
                        Please fill in and submit the form
                    </div>
                    <form id="cc-form">
                        <div class="form-group">
                            <label for="cc-pin">PIN</label>
                            <span id="cc-pin" class="form-field">
                  <!--VGS Collect iframe for PIN field will be here!-->
                </span>
                        </div>
                        <!--Submit form button-->
                        <button type="submit" class="btn btn-success btn-block">Submit</button>
                    </form>
                </div>
            </div>
        </div>
        <div class="col-md-4"></div>
    </div>
</main>

<!--Include script with VGS Collect form initialization-->
<script>
    // VGS Collect form initialization
    const form = VGSCollect.create("tntazhyknp1", "sandbox", function(state) {});
    const customerToken = "<CUSTOMER TOKEN>"

    // Create VGS Collect field for PIN
    form.field('#cc-pin', {
        type: 'text',
        name: 'data.attributes.pin',
        successColor: '#4F8A10',
        errorColor: '#D8000C',
        placeholder: '1234',
        maxLength: 6,
        validations: ['required', '/^([0-9]{4,6})$/'],
    });

    // Submit by executing a POST request.
    document.getElementById('cc-form')
        .addEventListener('submit', function(e) {
            e.preventDefault();
            form.submit('/cards/<CARD ID>/secure-data/pin',
                {
                    // This converts the dot-separated field name string into a JSON object
                    mapDotToObject: 'true',
                    headers: {
                        "Content-Type": "application/vnd.api+json",
                        "Authorization": "Bearer " + customerToken
                    }
                },


                function(status, data) {
                    console.log(data);
                });
        }, function (errors) {
            console.log(errors);
        });
</script>
</body>
</html>

Import the VGS Collect library: <script type="text/javascript" src="https://js.verygoodvault.com/vgs-collect/2.9.0/vgs-collect.js"></script>

Initialize the component:

const form = VGSCollect.create("tntazhyknp1", "sandbox", function(state) {});

The Vault Id tntazhyknp1 enables you to test your code in a sandbox environment. Contact Unit for the live Vault Id.

Provide a valid customer token:

const customerToken = "<CUSTOMER TOKEN>"

For instructions, see Create Customer Token.

Provide a valid card identifier:

path: '/cards/<CARD ID>/secure-data/pin'

Required field names and formats:

PIN field name should be data.attributes.pin.

Additional resources

SDKs for iOS and Android and additional code examples can be found here.

Change PIN

In order to change an existing PIN, without any sensitive data passing through your systems (which requires PCI compliance), Unit utilizes a 3rd party service called Very Good Security or VGS for short.

VGS Collect JavaScript library injects a secure iframe into your HTML. VGS hosts both the iframe, and the data on secure, compliant servers.

Integration steps

Example of creating a Customer Token for Change PIN:

curl -X POST 'https://api.s.unit.sh/customers/8/token' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type":"customerToken",
    "attributes": {
      "scope": "cards-sensitive-write",
      "verificationToken": "i8FWKLBjXEg3TdeK93G3K9PKLzhbT6CRhn/VKkTsm....",
      "verificationCode": "203130"
    }
  }
}
'

Example of Change PIN:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Change PIN Example</title>

    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/css/bootstrap.min.css"
          integrity="sha384-Gn5384xqQ1aoWXA+058RXPxPg6fy4IWvTNh0E263XmFcJlSAwiGgFAW/dAiS6JXm" crossorigin="anonymous">

    <script type="text/javascript" src="https://js.verygoodvault.com/vgs-collect/2.9.0/vgs-collect.js"></script>

    <style>
        body {
            padding: 25px;
        }

        span[id*="cc-"] {
            display: block;
            height: 40px;
            margin-bottom: 15px;
        }

        span[id*="cc-"] iframe {
            height: 100%;
            width: 100%;
        }

        pre {
            font-size: 12px;
        }

        .form-field {
            display: block;
            width: 100%;
            height: calc(2.25rem + 2px);
            padding: .375rem .75rem;
            font-size: 1rem;
            line-height: 1.5;
            color: #495057;
            background-color: #fff;
            background-clip: padding-box;
            border: 1px solid #ced4da;
            border-radius: .25rem;
            transition: border-color .15s ease-in-out,box-shadow .15s ease-in-out;
        }

        .form-field iframe {
            border: 0 none transparent;
            height: 100%;
            vertical-align: middle;
            width: 100%;
        }

        p {
            margin-bottom: 10px;
        }
    </style>
</head>
<body>
<main>
    <div class="row">
        <div class="col-md-4"></div>
        <div class="col-md-4">
            <div class="row card card-outline-secondary">
                <div class="card-body">
                    <h3 class="text-center">Change PIN</h3>
                    <hr>
                    <div class="alert alert-info p-2">
                        Please fill in and submit the form
                    </div>
                    <form id="cc-form">
                        <div class="form-group">
                            <label for="cc-old-pin">Old PIN</label>
                            <span id="cc-old-pin" class="form-field">
                  <!--VGS Collect iframe for Old PIN field will be here!-->
                </span>
                        </div>
                        <div class="form-group">
                            <label for="cc-new-pin">New PIN</label>
                            <span id="cc-new-pin" class="form-field">
                  <!--VGS Collect iframe for New PIN field will be here!-->
                </span>
                        </div>
                        <!--Submit form button-->
                        <button type="submit" class="btn btn-success btn-block">Submit</button>
                    </form>
                </div>
            </div>
        </div>
        <div class="col-md-4"></div>
    </div>
</main>

<!--Include script with VGS Collect form initialization-->
<script>
    // VGS Collect form initialization
    const form = VGSCollect.create("tntazhyknp1", "sandbox", function(state) {});
    const customerToken = "<CUSTOMER TOKEN>"

    // Create VGS Collect field for Old PIN
    form.field('#cc-old-pin', {
        type: 'text',
        name: 'data.attributes.oldPin',
        successColor: '#4F8A10',
        errorColor: '#D8000C',
        placeholder: '1234',
        maxLength: 6,
        validations: ['required', '/^([0-9]{4,6})$/'],
    });

    // Create VGS Collect field for New PIN
    form.field('#cc-new-pin', {
        type: 'text',
        name: 'data.attributes.newPin',
        successColor: '#4F8A10',
        errorColor: '#D8000C',
        placeholder: '1234',
        maxLength: 6,
        validations: ['required', '/^([0-9]{4,6})$/'],
    });

    // Submit by executing a PUT request.
    document.getElementById('cc-form')
        .addEventListener('submit', function(e) {
            e.preventDefault();
            form.submit('/cards/10001/secure-data/pin',
                {
                    method: 'PUT',
                    mapDotToObject: 'true',
                    headers: {
                        "Content-Type": "application/vnd.api+json",
                        "Authorization": "Bearer " + customerToken
                    }
                },


                function(status, data) {
                    console.log(data);
                });
        }, function (errors) {
            console.log(errors);
        });
</script>
</body>
</html>

Import the VGS Collect library: <script type="text/javascript" src="https://js.verygoodvault.com/vgs-collect/2.9.0/vgs-collect.js"></script>

Initialize the component:

const form = VGSCollect.create("tntazhyknp1", "sandbox", function(state) {});

The Vault Id tntazhyknp1 enables you to test your code in a sandbox environment. Contact Unit for the live Vault Id.

Provide a valid customer token:

const customerToken = "<CUSTOMER TOKEN>"

For instructions, see Create Customer Token.

Provide a valid card identifier:

path: '/cards/<CARD ID>/secure-data/pin'

Required field names and formats:

Old PIN field name should be data.attributes.oldPin.
New PIN field name should be data.attributes.newPin.

Additional resources

SDKs for iOS and Android and additional code examples can be found here.

Report Stolen

Report card as stolen.

curl -X POST 'https://api.s.unit.sh/cards/6/report-stolen' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`POST`
Url	`https://api.s.unit.sh/cards/:cardId/report-stolen`
Required Scope	`cards-write`

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	IndividualDebitCard or BusinessDebitCard or IndividualVirtualDebitCard or BusinessVirtualDebitCard	Card resource, distinguished by the `type` field.

Report Lost

Report card as lost.

curl -X POST 'https://api.s.unit.sh/cards/5/report-lost' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`POST`
Url	`https://api.s.unit.sh/cards/:cardId/report-lost`
Required Scope	`cards-write`

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	IndividualDebitCard or BusinessDebitCard or IndividualVirtualDebitCard or BusinessVirtualDebitCard	Card resource, distinguished by the `type` field.

Close Card

Close a card.

curl -X POST 'https://api.s.unit.sh/cards/7/close' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`POST`
Url	`https://api.s.unit.sh/cards/:cardId/close`
Required Scope	`cards-write`

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	IndividualDebitCard or BusinessDebitCard or IndividualVirtualDebitCard or BusinessVirtualDebitCard	Card resource, distinguished by the `type` field.

Freeze Card

Freeze a card (temporarily block a card).

curl -X POST 'https://api.s.unit.sh/cards/8/freeze' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`POST`
Url	`https://api.s.unit.sh/cards/:cardId/freeze`
Required Scope	`cards-write`

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	IndividualDebitCard or BusinessDebitCard or IndividualVirtualDebitCard or BusinessVirtualDebitCard	Card resource, distinguished by the `type` field.

Unfreeze Card

Unfreeze a frozen card.

curl -X POST 'https://api.s.unit.sh/cards/8/unfreeze' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`POST`
Url	`https://api.s.unit.sh/cards/:cardId/unfreeze`
Required Scope	`cards-write`

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	IndividualDebitCard or BusinessDebitCard or IndividualVirtualDebitCard or BusinessVirtualDebitCard	Card resource, distinguished by the `type` field.

Replace Card

Creates and ships a replacement physical debit card to an individual or business card holder. The replacement card has the same card number, expiration date and PIN as the original card, and does not require activation.

Example Request:

curl -X POST 'https://api.s.unit.sh/cards/8/replace' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type":"replaceCard",
    "attributes": {
      "shippingAddress": {
        "street": "5230 Newell Rd",
        "city": "Palo Alto",
        "state": "CA",
        "postalCode": "94303",
        "country": "US"
      }
    }
  }
}'

Verb	`POST`
Url	`https://api.s.unit.sh/cards/:cardId/replace`
Required Scope	`cards-sensitive-write` or `cards-write`
Data Type	`replaceCard`

Attributes

Name	Type	Description
shippingAddress	Address	Address to ship the card to. Optional, if not specified, the address provided during card creation is reused.

Response

Response is a JSON:API document.

Example Response:

{
  "data": {
    "type": "individualDebitCard",
    "id": "8",
    "attributes": {
      "createdAt": "2020-05-13T09:07:47.645Z",
      "last4Digits": "1234",
      "expirationDate": "2022-05",
      "shippingAddress": {
        "street": "5230 Newell Rd",
        "street2": null,
        "city": "Palo Alto",
        "state": "CA",
        "postalCode": "94303",
        "country": "US"
      },
      "status": "Inactive"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "account",
          "id": "2"
        }
      },
      "customer": {
        "data": {
          "type": "customer",
          "id": "2"
        }
      }
    }
  }
}

200 OK

Field	Type	Description
data	IndividualDebitCard or BusinessDebitCard	Card resource, distinguished by the `type` field.

Get by Id

Get a card resource by id.

curl -X GET 'https://api.s.unit.sh/cards/1?include=customer' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/cards/{id}`
Required Scope	`cards`

Query Parameters

Name	Type	Default	Description
include	string	(empty)	Optional. A comma-separated list of related resources to include in the response. Related resources include: `customer`, `account`. See Getting Related Resources

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	IndividualDebitCard or BusinessDebitCard or IndividualVirtualDebitCard or BusinessVirtualDebitCard	Card resource, distinguished by the `type` field.
included	Array of DepositAccount or Customer	Array of resources requested by the `include` query parameter.

List

List cards. Filtering and paging can be applied.

curl -X GET 'https://api.s.unit.sh/cards?page[limit]=20&page[offset]=0&include=customer' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/cards`
Required Scope	`cards`

Query Parameters

Name	Type	Default	Description
page[limit]	integer	100	Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
page[offset]	integer	0	Number of resources to skip. See Pagination.
filter[accountId]	string	(empty)	Optional. Filters the results by the specified account id.
filter[customerId]	string	(empty)	Optional. Filters the results by the specified customer id.
filter[tags]	Tags (JSON)	(empty)	Optional. Filter Cards by Tags.
include	string	(empty)	Optional. A comma-separated list of related resources to include in the response. Related resources include: `customer`, `account`. See Getting Related Resources

Response

Example Response:

{
  "data": [
    {
      "type": "individualDebitCard",
      "id": "1",
      "attributes": {
        "createdAt": "2020-05-10T16:45:02.272Z",
        "last4Digits": "1234",
        "expirationDate": "2022-05",
        "status": "Active"
      },
      "relationships": {
        "account": {
          "data": {
            "type": "depositAccount",
            "id": "1"
          }
        },
        "customer": {
          "data": {
            "type": "individualCustomer",
            "id": "2"
          }
        }
      }
    },
    {
      "type": "businessDebitCard",
      "id": "4",
      "attributes": {
        "createdAt": "2020-05-10T20:37:48.069Z",
        "last4Digits": "1234",
        "expirationDate": "2022-05",
        "shippingAddress": {
          "street": "5230 Newell Rd",
          "street2": null,
          "city": "Palo Alto",
          "state": "CA",
          "postalCode": "94303",
          "country": "US"
        },
        "address": {
          "street": "5230 Newell Rd",
          "street2": null,
          "city": "Palo Alto",
          "state": "CA",
          "postalCode": "94303",
          "country": "US"
        },
        "fullName": {
          "first": "Richard",
          "last": "Hendricks"
        },
        "phone": {
          "countryCode": "1",
          "number": "5555555789"
        },
        "email": "richard@piedpiper.com",
        "dateOfBirth": "2001-08-10",
        "ssn": "123456789",
        "status": "Active"
      },
      "relationships": {
        "account": {
          "data": {
            "type": "depositAccount",
            "id": "1"
          }
        },
        "customer": {
          "data": {
            "type": "businessCustomer",
            "id": "1"
          }
        }
      }
    }
  ]
}

Response is a JSON:API document.

200 OK

Field	Type	Description
data	Array of IndividualDebitCard or BusinessDebitCard or IndividualVirtualDebitCard or BusinessVirtualDebitCard	Array of card resources, distinguished by the `type` field.
included	Array of DepositAccount or Customer	Array of resources requested by the `include` query parameter.

Update

Update a debit card.

Verb	`PATCH`
Url	`https://api.s.unit.sh/cards/:cardId`
Required Scope	`cards-write`

Example of update business debit card:

curl -X PATCH 'https://api.s.unit.sh/cards/:cardId' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type":"businessDebitCard",
    "attributes": {
      "shippingAddress": {
        "street": "5231 Newell Rd",
        "street2": null,
        "city": "Palo Alto",
        "state": "CA",
        "postalCode": "94301",
        "country": "US"
      },
      "address": {
        "street": "5231 Newell Rd",
        "street2": null,
        "city": "Palo Alto",
        "state": "CA",
        "postalCode": "94301",
        "country": "US"
      },
      "email": "richard@piedpiper.com",
      "phone": {
        "countryCode": "1",
        "number": "5555555556"
      }
    }
  }
}'

Update Individual Debit Card

Name	Type	Description
shippingAddress	Address	Address to ship the card to. To modify or add specify the key and value. To delete a key specify the key name and `null` for the value.
design	string	Card design name. To modify or add specify the key and value.
tags	object	See Updating Tags.

Update Business Debit Card

Name	Type	Description
shippingAddress	Address	Address to ship the card to. To modify or add specify the key and value. To delete a key specify the key name and `null` for the value.
address	Address	Address of the card holder. To modify or add specify the new address.
phone	Phone	Phone of the card holder. To modify or add specify the new phone number.
email	string	Email address of the card holder. To modify or add specify the new email address.
design	string	Card design name. To modify or add specify the key and value.
tags	object	See Updating Tags.

Update Individual Virtual Debit Card

Name	Type	Description
tags	object	See Updating Tags.

Update Business Virtual Debit Card

Name	Type	Description
address	Address	Address of the card holder. To modify or add specify the new address.
phone	Phone	Phone of the card holder. To modify or add specify the new phone number.
email	string	Email address of the card holder. To modify or add specify the new email address.
tags	object	See Updating Tags.

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	IndividualDebitCard Or BusinessDebitCard Or BusinessVirtualDebitCard Or IndividualVirtualDebitCard resource	The target resource after the operation was completed.

Cards: Authorization Requests

When an end-customer makes a purchase using a debit card, Unit creates an authorization request, allowing you to approve or decline the purchase. We refer to this process as Programmatic authorization of card purchases.

Restricting payments to certain types of institutions / services
Moving funds between accounts of the customer in real time to meet the authorization request amount.

Programmatic authorization of card purchases

The Programmatic authorization of card purchases includes the following steps:

An authorizationRequest.pending webhook event is sent by Unit.
You can then approve or decline the authorization request via an API call (see below).
If you do not approve or decline the authorization request within 2 seconds, Unit will approve or decline it according to the default that is defined for you on Unit's settings (which can be changed any time by contacting Unit).
The response from the approve operation will include the final authorization request status. Approving an authorization request may still result in a Declined status for different reasons. For example, at this stage Unit will check the balance on the account, and may decline the authorization due to insufficient funds.
Unit will send an authorizationRequest.approved or authorizationRequest.declined webhook event based on the final approval status.

Get by Id

Get an authorization request resource by id.

curl -X GET 'https://api.s.unit.sh/authorization-requests/1' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/authorization-requests/{id}`
Required Scope	`authorization-requests`

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	PurchaseAuthorizationRequest	Authorization Request resource.

List

List authorization requests. Filtering and paging can be applied.

curl -X GET 'https://api.s.unit.sh/authorization-requests?page[limit]=20&page[offset]=0' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/authorization-requests`
Required Scope	`authorization-requests`

Query Parameters

Name	Type	Default	Description
page[limit]	integer	100	Maximum number of resources that will be returned. Maximum is 1000 resources.
page[offset]	integer	0	Number of resources to skip.
filter[accountId]	string	(empty)	Optional. Filters the results by the specified account id.
filter[customerId]	string	(empty)	Optional. Filters the results by the specified customer id.

Response

Example Response:

{
  "data": [
    {
      "type": "purchaseAuthorizationRequest",
      "id": "1",
      "attributes": {
        "createdAt": "2021-06-22T13:39:17.018Z",
        "amount": 2500,
        "status": "Approved",
        "partialApprovalAllowed": false,
        "approvedAmount": 2500,
        "merchant": {
          "name": "Apple Inc.",
          "type": 1000,
          "category": "",
          "location": "Cupertino, CA"
        },
        "recurring": false
      },
      "relationships": {
        "customer": {
          "data": {
            "type": "customer",
            "id": "10000"
          }
        },
        "account": {
          "data": {
            "type": "account",
            "id": "10001"
          }
        },
        "card": {
          "data": {
            "type": "card",
            "id": "7"
          }
        }
      }
    },
    {
      "type": "purchaseAuthorizationRequest",
      "id": "2",
      "attributes": {
        "createdAt": "2021-06-22T13:41:01.379Z",
        "amount": 2500,
        "status": "Pending",
        "partialApprovalAllowed": false,
        "merchant": {
          "name": "Apple Inc.",
          "type": 1000,
          "category": "",
          "location": "Cupertino, CA"
        },
        "recurring": false
      },
      "relationships": {
        "customer": {
          "data": {
            "type": "customer",
            "id": "10000"
          }
        },
        "account": {
          "data": {
            "type": "account",
            "id": "10001"
          }
        },
        "card": {
          "data": {
            "type": "card",
            "id": "7"
          }
        }
      }
    }
  ]
}

Response is a JSON:API document.

200 OK

Field	Type	Description
data	Array of PurchaseAuthorizationRequest	Array of authorization request resources.

Approve

Approves a pending authorization request.

Example Request:

curl -X POST 'https://api.s.unit.sh/authorization-requests/1/approve' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data": {
    "type": "approveAuthorizationRequest",
    "attributes": {
      "amount": 5000
    }
  }
}'

Verb	`POST`
Url	`https://api.s.unit.sh/authorization-requests/:id/approve`
Required Scope	`authorization-requests-write`
Data Type	`approveAuthorizationRequest`

Attributes

Name	Type	Description
amount	integer	Optional. The approved amount (in cents). Can only be specified if the authorization request's `partialApprovalAllowed` is set to `true`.

Response

Response is a JSON:API document.

Example Response:

{
  "data": {
    "type": "purchaseAuthorizationRequest",
    "id": "1",
    "attributes": {
      "createdAt": "2021-06-22T13:39:17.018Z",
      "amount": 2500,
      "status": "Approved",
      "partialApprovalAllowed": true,
      "approvedAmount": 2500,
      "merchant": {
        "name": "Apple Inc.",
        "type": 1000,
        "category": "",
        "location": "Cupertino, CA"
      },
      "recurring": false
    },
    "relationships": {
      "customer": {
        "data": {
          "type": "customer",
          "id": "10000"
        }
      },
      "account": {
        "data": {
          "type": "account",
          "id": "10001"
        }
      },
      "card": {
        "data": {
          "type": "card",
          "id": "7"
        }
      }
    }
  }
}

200 OK

Field	Type	Description
data	PurchaseAuthorizationRequest	The target resource after the operation was completed.

Decline

Declines a pending authorization request.

Example Request:

curl -X POST 'https://api.s.unit.sh/authorization-requests/1/decline' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data": {
    "type": "declineAuthorizationRequest",
    "attributes": {
      "reason": "InsufficientFunds"
    }
  }
}'

Verb	`POST`
Url	`https://api.s.unit.sh/authorization-requests/:id/decline`
Required Scope	`authorization-requests-write`
Data Type	`declineAuthorizationRequest`

Attributes

Name	Type	Description
reason	string	The reason for declining the authorization request. One of `AccountClosed`, `CardExceedsAmountLimit`, `DoNotHonor`, `InsufficientFunds`, `InvalidMerchant`, `ReferToCardIssuer`, `RestrictedCard`, `TransactionNotPermittedToCardholder`.

Response

Response is a JSON:API document.

Example Response:

{
  "data": {
    "type": "purchaseAuthorizationRequest",
    "id": "1",
    "attributes": {
      "createdAt": "2021-06-22T13:39:17.018Z",
      "amount": 2500,
      "status": "Declined",
      "partialApprovalAllowed": true,
      "declineReason": "InsufficientFunds",
      "merchant": {
        "name": "Apple Inc.",
        "type": 1000,
        "category": "",
        "location": "Cupertino, CA"
      },
      "recurring": false
    },
    "relationships": {
      "customer": {
        "data": {
          "type": "customer",
          "id": "10000"
        }
      },
      "account": {
        "data": {
          "type": "account",
          "id": "10001"
        }
      },
      "card": {
        "data": {
          "type": "card",
          "id": "7"
        }
      }
    }
  }
}

200 OK

Field	Type	Description
data	PurchaseAuthorizationRequest	The target resource after the operation was completed.

Cards: Authorizations

The authorization (also authorization hold) process is an essential step in completing a card transaction. During authorization, the merchant receives the card holder’s information and verifies that the card is valid and that the card holder has sufficient funds to cover the amount of the transaction. Most merchants proceed immediately from authorization to the completion of the transaction, but they have the option to place a hold instead.

An authorization effectively “reserves” a certain amount of the card holder’s available funds for the merchant upon completion of the card transaction. The amount of the authorization is made unavailable to the card holder, but it isn’t transferred to the merchant’s account—not yet. When the transaction is settled, the authorization will be removed, and the card holder is charged the actual, final purchase amount.

The authorized amount will be included in the card holder account hold amount and will be reflected in the account available amount (see Deposit Account)

Get by Id

Get an authorization resource by id.

curl -X GET 'https://api.s.unit.sh/authorizations/1' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/authorizations/{id}`
Required Scope	`authorizations`

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	Authorization	Authorization resource.

List

List authorizations. Filtering and paging can be applied.

curl -X GET 'https://api.s.unit.sh/authorizations?page[limit]=20&page[offset]=0' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/authorizations`
Required Scope	`authorizations`

Query Parameters

Name	Type	Default	Description
page[limit]	integer	100	Maximum number of resources that will be returned. Maximum is 1000 resources.
page[offset]	integer	0	Number of resources to skip.
filter[accountId]	string	(empty)	Optional. Filters the results by the specified account id.
filter[customerId]	string	(empty)	Optional. Filters the results by the specified customer id.
filter[since]	RFC3339 Date string	(empty)	Optional. Filters the Authorizations that occurred after the specified date. e.g. `2020-01-13T16:01:19.346Z`
filter[until]	RFC3339 Date string	(empty)	Optional. Filters the Authorizations that occurred before the specified date. e.g. `2020-01-02T20:06:23.486Z`

Response

Example Response:

{
  "data": [
    {
      "type": "authorization",
      "id": "90",
      "attributes": {
        "createdAt": "2021-02-16T07:40:44.970Z",
        "amount": 2000,
        "cardLast4Digits": "",
        "merchant": {
          "name": "Europcar Mobility Group",
          "type": 3381,
          "category": "EUROP CAR",
          "location": "Cupertino, CA"
        }
      },
      "relationships": {
        "customer": {
          "data": {
            "type": "customer",
            "id": "10000"
          }
        },
        "account": {
          "data": {
            "type": "account",
            "id": "10001"
          }
        }
      }
    }
  ]
}

Response is a JSON:API document.

200 OK

Field	Type	Description
data	Array of Authorization	Array of authorization resources.

Check Deposits

Unit enables Check deposits using a standard Remote Deposit Capture (RDC) mechanism.

Once a check deposit is created, and the check's images are uploaded, Unit will validate the images, process the check and credit the customer's deposit account.

Check Deposit Status

When you create a check deposit it will be created with an AwaitingImages status. You may track its progress using the status attribute or listening to relevant webhooks.

The possible status values are:

Status	Description
`AwaitingImages`	The check deposit was created. Waiting for the front-side and back-side images to be uploaded.
`AwaitingFrontImage`	The back-side image of the check was received. Waiting for the front-side image to be uploaded.
`AwaitingBackImage`	The front-side image of the check was received. Waiting for the back-side image to be uploaded.
`Pending`	The check deposit was created on the Unit ledger but was not yet processed. Check deposits with `Pending` status may be canceled by the originator.
`PendingReview`	The check deposit is pending review by Unit.
`Rejected`	The check deposit was rejected (see `reason` for more details).
`Clearing`	The check deposit was sent but the deposit account was not credited yet.
`Sent`	The check deposit was processed and approved. This is the final state for successful check deposits.
`Canceled`	The check deposit was canceled.
`Returned`	The check deposit was processed but the receiving bank was not able to complete the transfer (see `reason` for more details).

Create Check Deposit

Example Request:

curl -X POST 'https://api.s.unit.sh/check-deposits' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type":"checkDeposit",
    "attributes": {
      "amount": 20000,
      "description": "Check deposit"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "10001"
        }
      }
    }
  }
}'

Creates a check deposit for an Account.

Verb	`POST`
Url	`https://api.s.unit.sh/check-deposits`
Required Scope	`check-deposits-write`
Data Type	`checkDeposit`

Attributes

Name	Type	Description
amount	integer	The check amount (in cents) to deposit.
description	string	Description of the check deposit (maximum of 50 characters).
tags	object	See Tags.
idempotencyKey	string	See Idempotency.

Relationships

Name	Type	Description
account	JSON:API Relationship	The account receiving the check deposit.

Response

Response is a JSON:API document.

Example Response:

{
  "data": {
    "type": "checkDeposit",
    "id": "1112",
    "attributes": {
      "createdAt": "2021-05-27T09:29:30.828Z",
      "amount": 20000,
      "description": "Check deposit",
      "status": "AwaitingImages"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "account",
          "id": "10001"
        }
      },
      "customer": {
        "data": {
          "type": "customer",
          "id": "10000"
        }
      }
    }
  }
}

201 Created

Field	Type	Description
data	CheckDeposit	The requested resource after the operation was completed.

Get by Id

Get a check deposit by id.

curl -X GET 'https://api.s.unit.sh/check-deposits/100' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/check-deposits/{id}`
Required Scope	`check-deposits`

Query Parameters

Name	Type	Default	Description
include	string	(empty)	Optional. A comma-separated list of related resources to include in the response. Related resources include: `customer`, `account`, `transaction`. See Getting Related Resources

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	Check Deposit	CheckDeposit resource.
included	Array of DepositAccount or Customer or Transaction	Array of resources requested by the `include` query parameter.

List

List check deposit resources. Filtering, paging and sorting can be applied.

curl -X GET 'https://api.s.unit.sh/check-deposits?page[limit]=20&page[offset]=10' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/check-deposits`
Required Scope	`check-deposits`

Query Parameters

Name	Type	Default	Description
page[limit]	integer	100	Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
page[offset]	integer	0	Number of resources to skip. See Pagination.
filter[accountId]	string	(empty)	Optional. Filters the results by the specified account id.
filter[customerId]	string	(empty)	Optional. Filters the results by the specified customer id.
filter[tags]	Tags (JSON)	(empty)	Optional. Filter check deposits by Tags.
sort	string	`sort=-createdAt`	Optional. Leave empty or provide `sort=createdAt` for ascending order. Provide `sort=-createdAt` (leading minus sign) for descending order.
include	string	(empty)	Optional. A comma-separated list of related resources to include in the response. Related resources include: `customer`, `account`, `transaction`. See Getting Related Resources

Response

Example Response:

{
  "data": [
    {
      "type": "checkDeposit",
      "id": "112",
      "attributes": {
        "createdAt": "2021-05-27T09:29:30.828Z",
        "amount": 20000,
        "description": "Check deposit",
        "status": "AwaitingImages"
      },
      "relationships": {
        "account": {
          "data": {
            "type": "account",
            "id": "10001"
          }
        },
        "customer": {
          "data": {
            "type": "customer",
            "id": "10000"
          }
        }
      }
    },
    {
      "type": "checkDeposit",
      "id": "233",
      "attributes": {
        "createdAt": "2021-05-27T10:49:23.287Z",
        "amount": 10000,
        "description": "Another check deposit",
        "status": "AwaitingImages"
      },
      "relationships": {
        "account": {
          "data": {
            "type": "account",
            "id": "10001"
          }
        },
        "customer": {
          "data": {
            "type": "customer",
            "id": "10000"
          }
        }
      }
    }
  ]
}

Response is a JSON:API document.

200 OK

Field	Type	Description
data	Array of Check Deposit	Array of check deposit resources.
included	Array of DepositAccount or Customer or Transaction	Array of resources requested by the `include` query parameter.

Update

Update a check deposit.

Update check deposit:

curl -X PATCH 'https://api.s.unit.sh/check-deposits/:id' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type": "checkDeposit",
    "attributes": {
      "tags": {
        "by": "Richard Hendricks",
        "id": "23033b64-38f8-4dbc-91a1-313ff0156d02"
      }
    }
  }
}'

Verb	`PATCH`
Url	`https://api.s.unit.sh/check-deposits/:id`
Required Scope	`check-deposits-write`

Attributes

Name	Type	Description
tags	object	See Updating Tags.

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	CheckDeposit	The updated CheckDeposit resource.

Upload Front-Side Image

Uploads a check front-side image file. Currently only jpeg file type is supported.

curl --request PUT 'https://api.s.unit.sh/check-deposits/46/front' \
--header 'Content-Type: image/jpeg' \
--data-binary 'front.jpg'

Verb	`PUT`
Url	`https://api.s.unit.sh/check-deposits/{checkDepositId}/front`
Required Scope	`check-deposits-write`

Headers

Header	Value
Content-Type	Always `image/jpeg`.

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	CheckDeposit	The updated CheckDeposit resource.

Upload Back-Side Image

Uploads a check back-side image file. Currently only jpeg file type is supported.

curl --request PUT 'https://api.s.unit.sh/check-deposits/46/back' \
--header 'Content-Type: image/jpeg' \
--data-binary 'back.jpg'

Verb	`PUT`
Url	`https://api.s.unit.sh/check-deposits/{checkDepositId}/back`
Required Scope	`check-deposits-write`

Headers

Header	Value
Content-Type	Always `image/jpeg`.

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	CheckDeposit	The updated CheckDeposit resource.

Transactions

A transaction is an individual entry that represents any financial movement within an account. The Transaction resource represents confirmed transactions that were posted to the account, including their source, amount, and direction.

Unit currently supports the following types of transactions.

Type	Description
Originated ACH	An ACH payment originated from a deposit account.
Received ACH	An ACH payment received by a deposit account.
Returned ACH	An ACH payment returned by the bank.
Dishonored Return ACH	A returned ACH that was dishonored by the receiving bank.
Wire	A wire transaction, either received or sent.
Book	A payment between two accounts on the same bank.
Purchase	A purchase via debit card.
ATM	A deposit or a withdrawal of funds from an ATM with a debit card.
Fee	Fees incurred for a transaction.
Interest	An Interest payment to a deposit account.
Card Reversal	A reversal of a previous card transaction.
Card Transaction	A transaction that represents various card transactions that are not `Purchase` or `ATM` transactions. Those might be split in the future into different types.
Release	A transaction releasing funds from a batch account.
Adjustment	Manual Adjustment is made in situations where the correction of an amount, or a reverse of a completed transaction is needed.
Dispute	Dispute transaction is created in order to credit or debit a customer for an ongoing card or ACH dispute. For example, when provisional credit is provided, the customer account would be credited using the Dispute Transaction.
Check Deposit	A received check deposit.
Returned Check Deposit	A check deposit returned by the bank.

In addition to their own specific fields, all transaction types are guaranteed to contain the following top-level fields:

Field	type	Description
direction	string	The direction in which the funds flow- Debit or Credit.
amount	integer	The amount (cents) of the transaction.
balance	integer	The account balance (cents) after the transaction.
summary	string	Human-friendly summary of the transaction.
createdAt	RFC3339 Date string	The date the transaction was created

New transaction types may be added in the future, as we introduce new financial products. To minimize code changes on your side, we recommend using the summary field when displaying transactions to end-customers.

Get by Id

Get a transaction by transaction id and account id.

curl -X GET 'https://api.s.unit.sh/accounts/:accountId/transactions/:transactionId' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/accounts/:accountId/transactions/{transactionId}`
Required Scope	`transactions`

Query Parameters

Name	Type	Default	Description
filter[customerId]	string	(none)	Optional. Filters the result by the specified customer id.
include	string	(empty)	Optional. A comma-separated list of related resources to include in the response. Related resources include: `customer`, `account`. See Getting Related Resources

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	One of OriginatedAchTransaction ReceivedAchTransaction BookTransaction PurchaseTransaction AtmTransaction FeeTransaction CardTransaction CardReversalTransaction	Transaction resources.
included	Array of DepositAccount or Customer	Array of resources requested by the `include` query parameter.

List

List transaction resources. Filtering, paging and sorting can be applied.

curl -X GET 'https://api.s.unit.sh/transactions?page[limit]=20&page[offset]=10' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/transactions`
Required Scope	`transactions`

Query Parameters

Name	Type	Default	Description
page[limit]	integer	100	Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
page[offset]	integer	0	Number of resources to skip. See Pagination.
filter[accountId]	string	(empty)	Optional. Filters the results by the specified account id.
filter[customerId]	string	(empty)	Optional. Filters the results by the specified customer id.
filter[query]	string	(empty)	Optional. search term according to the Full-Text Search Rules.
filter[tags]	Tags (JSON)	(empty)	Optional. Filter Transactions by Tags.
filter[since]	RFC3339 Date string	(empty)	Optional. Filters the Transactions that occurred after the specified date. e.g. `2020-01-13T16:01:19.346Z`
filter[until]	RFC3339 Date string	(empty)	Optional. Filters the Transactions that occurred before the specified date. e.g. `2020-01-02T20:06:23.486Z`
filter[cardId]	string	(empty)	Optional. Filters the results by the specified card id.
sort	string	`sort=-createdAt`	Optional. Leave empty or provide `sort=createdAt` for ascending order. Provide `sort=-createdAt` (leading minus sign) for descending order.
include	string	(empty)	Optional. A comma-separated list of related resources to include in the response. Related resources include: `customer`, `account`. See Getting Related Resources

Response

Example Response:

{
  "data": [
    {
      "type": "originatedAchTransaction",
      "id": "337",
      "attributes": {
        "createdAt": "2020-09-06T07:51:02.570Z",
        "direction": "Credit",
        "amount": 10000,
        "balance": 10000,
        "summary": "Counterparty: Unit Inc | Description: Funding",
        "description": "Funding",
        "counterparty": {
          "name": "Unit Inc",
          "routingNumber": "812345678",
          "accountNumber": "1",
          "accountType": "Checking"
        }
      },
      "relationships": {
        "account": {
          "data": {
            "type": "account",
            "id": "10001"
          }
        },
        "customer": {
          "data": {
            "type": "customer",
            "id": "3"
          }
        }
      }
    },
    {
      "type": "feeTransaction",
      "id": "338",
      "attributes": {
        "createdAt": "2020-09-06T07:51:03.094Z",
        "direction": "Debit",
        "amount": 10,
        "balance": 9990,
        "summary": "Fee - Funding"
      },
      "relationships": {
        "account": {
          "data": {
            "type": "account",
            "id": "10001"
          }
        },
        "customer": {
          "data": {
            "type": "customer",
            "id": "3"
          }
        },
        "relatedTransaction": {
          "data": {
            "type": "transaction",
            "id": "337"
          }
        }
      }
    }
  ]
}

Response is a JSON:API document.

200 OK

Field	Type	Description
data	Array of OriginatedAchTransaction or ReceivedAchTransaction or BookTransaction or PurchaseTransaction or AtmTransaction or FeeTransaction or CardTransaction or CardReversalTransaction	Array of transaction resources.
included	Array of DepositAccount or Customer	Array of resources requested by the `include` query parameter.

Update

Example Request:

Update Transaction

{
  "data": {
    "type": "transaction",
    "attributes": {
      "tags": {
        "trackUserId": 1234
      }
    }
  }
}

Verb	`PATCH`
Url	`https://api.s.unit.sh/accounts/:accountId/transactions/:transactionId`
Required Scope	`transactions-write`

Attributes

Name	Type	Description
tags	object	See Updating Tags.

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	One of OriginatedAchTransaction ReceivedAchTransaction BookTransaction PurchaseTransaction AtmTransaction FeeTransaction CardTransaction CardReversalTransaction	Transaction resources.

Fees

Fees allow you to charge the customer custom fees according to your business rules, like monthly subscriptions. The fees will be paid to your Revenue Account and will show up on the customer monthly statements.

Create Fee

Example Request:

curl -X POST 'https://api.s.unit.sh/fees' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data": {
    "type": "fee",
    "attributes": {
      "amount": 1000,
      "description": "Monthly Subscription"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "10097"
        }
      }
    }
  }
}'

Creates a fee for an Account.

Verb	`POST`
Url	`https://api.s.unit.sh/fees`
Required Scope	`accounts-write`
Data Type	`fee`

Attributes

Name	Type	Description
amount	integer	The amount (in cents) to charge the account.
description	string	Description of the fee (maximum of 50 characters).
tags	object	See Tags.
idempotencyKey	string	See Idempotency.

Relationships

Name	Type	Description
account	JSON:API Relationship	The account to charge the fee.

Response

Response is a JSON:API document.

Example Response:

{
  "data": {
    "type": "fee",
    "id": "1234",
    "attributes": {
      "amount": 1000,
      "description": "Monthly Subscription"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "10097"
        }
      }
    }
  }
}

201 Created

Field	Type	Description
data	Fee	The requested resource after the operation was completed.

Institutions

Get the details (name, supported payment types) of a financial institution, by routing number.

Get by routing number

Get an institution resource by routing number.

curl -X GET 'https://api.s.unit.sh/institutions/053285241' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/institutions/{routingNumber}`
Required Scope	`institutions`

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	Institution	Institution resource.

Batch Payments

A batch payment is any incoming payment into a batch account, which is a type of organization account. Once a batch payment is received, you are expected to split it between multiple customer accounts in your organization. This action is known as Release.

Batch accounts are meant to hold funds for a short period of time (typically less than a day). They serve use cases that deposit accounts cannot serve for compliance reasons. One such use case is send funds representing N businesses from a payment processor (e.g. WePay or Stripe) into N accounts under the same N businesses on Unit.

Batch Account

curl -X GET 'https://api.s.unit.sh/accounts/10104' \
-H "Authorization: Bearer ${TOKEN}"

Example Response

{
    "data": {
        "type": "batchAccount",
        "id": "10104",
        "attributes": {
            "createdAt": "2020-12-09T12:17:49.849Z",
            "name": "Pied Piper batch account",
            "routingNumber": "812345678",
            "accountNumber": "1000000104",
            "balance": 0,
            "hold": 0
        },
        "relationships": {
            "org": {
                "data": {
                    "type": "org",
                    "id": "1"
                }
            }
        }
    }
}

A batch account is a type of organization account. You may instruct other institutions or payment processors to send funds directly into it, by sharing its routing number and account number.

Create Batch Releases

Example Request:

curl -X POST 'https://api.s.unit.sh/batch-releases' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":[
    {
      "type": "batchRelease",
      "attributes": {
        "amount": 3000,
        "description": "Gift",
        "senderName": "Sherlock Holmes",
        "senderAccountNumber": "4581133972",
        "senderAddress": {
          "street": "221B Baker Street",
          "city": "London",
          "postalCode": "NW1 6XE",
          "country": "GB"
        }
      },
      "relationships": {
        "batchAccount": {
          "data": {
            "type": "batchAccount",
            "id": "10104"
          }
        },
        "receiver": {
          "data": {
            "type": "depositAccount",
            "id": "10097"
          }
        }
      }
    },
    {
      "type":"batchRelease",
      "attributes": {
        "amount": 2000,
        "description": "Purchase",
        "senderName": "Peter Parker",
        "senderAccountNumber": "5324131257",
        "senderAddress": {
          "street": "5230 Newell Rd",
          "city": "Palo Alto",
          "state": "CA",
          "postalCode": "94303",
          "country": "US"
        }
      },
      "relationships": {
        "batchAccount": {
          "data": {
            "type": "batchAccount",
            "id": "10104"
          }
        },
        "receiver": {
          "data": {
            "type": "depositAccount",
            "id": "10017"
          }
        }
      }
    }]
}'

Release is the act of splitting a single batch payment between multiple customer accounts in your organization. When creating releases, you are required to provide compliance information for the original senders of the funds.

In contrast to other Create operations, Create Batch Releases creates multiple releases in a *single* API call by taking a data array.

Verb	`POST`
Url	`https://api.s.unit.sh/batch-releases`
Required Scope	`batch-releases-write`
Data Type	`batchRelease`

Attributes

Name	Type	Description
amount	integer	The amount (in cents) to move from the batch account to the receiver account.
description	string	Description of the payment (maximum of 50 characters).
senderName	string	Sender name for the payment (maximum of 255 characters).
senderAddress	Address	Sender address for the payment.
senderAccountNumber	string	A unique identifier for the sender of the payment (maximum of 17 characters). As an example, when the payment comes from a card processor, this identifier may be set to the BIN followed by the last four digits of the card used.
tags	object	See Tags will be passed to the related Release Transaction.

Relationships

Name	Type	Description
batchAccount	JSON:API Relationship	The batch account to release the funds from.
receiver	JSON:API Relationship	The receiver account to release the funds to.

Response

Example Response:

{
  "data":[
    {
      "type": "batchRelease",
      "id": "100123",
      "attributes": {
        "amount": 3000,
        "description": "Gift",
        "senderName": "Sherlock Holmes",
        "senderAccountNumber": "4581133972",
        "senderAddress": {
          "street": "221B Baker Street",
          "city": "London",
          "postalCode": "NW1 6XE",
          "country": "GB"
        }
      },
      "relationships": {
        "batchAccount": {
          "data": {
            "type": "batchAccount",
            "id": "10104"
          }
        },
        "receiver": {
          "data": {
            "type": "depositAccount",
            "id": "10097"
          }
        }
      }
    },
    {
      "type":"batchRelease",
      "id": "100125",
      "attributes": {
        "amount": 2000,
        "description": "Purchase",
        "senderName": "Peter Parker",
        "senderAccountNumber": "5324131257",
        "senderAddress": {
          "street": "5230 Newell Rd",
          "city": "Palo Alto",
          "state": "CA",
          "postalCode": "94303",
          "country": "US"
        }
      },
      "relationships": {
        "batchAccount": {
          "data": {
            "type": "batchAccount",
            "id": "10104"
          }
        },
        "receiver": {
          "data": {
            "type": "depositAccount",
            "id": "10017"
          }
        }
      }
    }]
}

Response is a JSON:API document.

201 Created

Field	Type	Description
data	Array of BatchRelease	Array of batch release resources.

Simulations (Sandbox only)

Unit's Sandbox environment provides additional operations on top of the regular APIs. Those operations allow you to easily test and simulate activities that would normally take a long time or require interaction with the external world.

A common example for testing would be Simulating a Received ACH Payment to create funds in an account, followed by Simulating a Card Purchase to spend those funds.

Application Statuses

By default, all applications in our sandbox will be approved immediately. Below are ways to simulate other statuses:

Status	Description
`PendingReview`	Individual application: set the SSN on the application to 000000004. Business application: set the SSN of the Officer or any Beneficial Owner on the application to 000000004.
`AwaitingDocuments`	Individual application: set the SSN on the application to 000000002 to simulate AwaitingDocuments for Address Verification, or 000000003 to simulate AwaitingDocuments for Id Document, or 000000006 to simulate AwaitingDocuments for Social Security Card. Business application: set the SSN of the Officer on the application to 000000005.
`Denied`	Individual application: set the SSN on the application to 000000001.

Approve Application

Example Request:

curl -X POST 'https://api.s.unit.sh/sandbox/applications/10001/approve' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data": {
    "type": "applicationApprove",
    "attributes": {
      "reason": "sandbox"
    }
  }
}'

Approves an Application under PendingReview or AwaitingDocuments status. The Customer Created webhook event will be fired.

Verb	`POST`
Url	`https://api.s.unit.sh/sandbox/applications/{applicationId}/approve`
Data Type	`applicationApprove`

Deny Application

Example Request:

curl -X POST 'https://api.s.unit.sh/sandbox/applications/10001/deny' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data": {
    "type": "applicationDeny",
    "attributes": {
      "reason": "sandbox"
    }
  }
}'

Denies an Application under PendingReview or AwaitingDocuments status. The Application Denied webhook event will be fired.

Verb	`POST`
Url	`https://api.s.unit.sh/sandbox/applications/{applicationId}/deny`
Data Type	`applicationDeny`

Approve Document

Example Request:

curl -X POST 'https://api.s.unit.sh/sandbox/applications/10001/documents/1/approve' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{}'

Approves an Application Document. The Document Approved webhook event will be fired.

Verb	`POST`
Url	`https://api.s.unit.sh/sandbox/applications/{applicationId}/documents/{documentId}/approve`

Reject Document

Example Request:

curl -X POST 'https://api.s.unit.sh/sandbox/applications/10001/documents/1/reject' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data": {
    "type": "documentReject",
    "attributes": {
      "reason": "blurry image",
      "reasonCode": "PoorQuality"
    }
  }
}'

Rejects an Application Document. The Document Rejected webhook event will be fired.

Verb	`POST`
Url	`https://api.s.unit.sh/sandbox/applications/{applicationId}/documents/{documentId}/reject`
Data Type	`documentReject`

Receive ACH payment

Example Request:

curl -X POST 'https://api.s.unit.sh/sandbox/payments' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type":"achPayment",
    "attributes": {
      "amount": 10000,
      "direction": "Credit",
      "description": "Payment from Sandbox"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "1000"
        }
      }
    }
  }
}'

This API allows you to simulate an incoming ACH payment with the specified amount (in cents) for testing purposes. The Transaction Created webhook event will be fired.

Verb	`POST`
Url	`https://api.s.unit.sh/sandbox/payments`
Data Type	`achPayment`

Attributes

Name	Type	Description
amount	integer	The amount (in cents).
direction	string	The direction in which the funds flow (currently, only `Credit` is supported).
description	string	Payment description (maximum of 50 characters).

Relationships

Name	Type	Description
account	JSON:API Relationship	The Deposit Account receiving the payment.

Example Response:

{
  "data": {
      "type": "achPayment",
      "id": "3",
      "attributes": {
          "createdAt": "2020-06-29T13:17:59.816Z",
          "amount": 10000,
          "direction": "Credit",
          "description": "Payment from Sandbox",
          "status": "Sent",
          "reason": null
      },
      "relationships": {
          "account": {
              "data": {
                  "type": "depositAccount",
                  "id": "1000"
              }
          },
          "customer": {
              "data": {
                  "type": "individualCustomer",
                  "id": "1"
              }
          }
      }
  }
}

Note: the status for the sandbox payment requests is always Sent. Please refer to ACH Status for more information about the status codes.

Transmit ACH payment

Example Request:

curl -X POST 'https://api.s.unit.sh/sandbox/ach/transmit' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type":"transmitAchPayment",
    "relationships": {
      "payment": {
        "data": {
          "type": "achPayment",
          "id": "10"
        }
      }
    }
  }
}'

This API allows you to simulate a file transmission to the network for an existing ACH payment with Pending status. After transmission, the status would change to Sent for ACH Credit payment and Clearing for ACH Debit payment. The Payment Sent or Payment Clearing webhook event will be fired.

Verb	`POST`
Url	`https://api.s.unit.sh/sandbox/ach/transmit`
Data Type	`transmitAchPayment`

Relationships

Name	Type	Description
payment	JSON:API Relationship	The ACH Payment to transmit.

Example Response:

{
  "data": {
    "type": "achPayment",
    "id": "10",
    "attributes": {
      "createdAt": "2021-03-09T15:02:01.543Z",
      "amount": 10000,
      "direction": "Debit",
      "description": "Payment from Sandbox",
      "status": "Clearing"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "account",
          "id": "10001"
        }
      },
      "customer": {
        "data": {
          "type": "customer",
          "id": "10000"
        }
      }
    }
  }
}

Clear ACH payment

Example Request:

curl -X POST 'https://api.s.unit.sh/sandbox/ach/clear' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type":"clearAchPayment",
    "relationships": {
      "payment": {
        "data": {
          "type": "achPayment",
          "id": "10"
        }
      }
    }
  }
}'

This API allows you to immediately clear an existing ACH payment with Clearing status without waiting for the end of the clearing period. The Payment Sent and Transaction Created webhook events will be fired.

Verb	`POST`
Url	`https://api.s.unit.sh/sandbox/ach/clear`
Data Type	`clearAchPayment`

Relationships

Name	Type	Description
payment	JSON:API Relationship	The ACH Payment to be cleared.

Example Response:

{
  "data": {
    "type": "achPayment",
    "id": "10",
    "attributes": {
      "createdAt": "2021-03-09T15:02:01.543Z",
      "amount": 10000,
      "direction": "Debit",
      "description": "Payment from Sandbox",
      "status": "Sent"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "account",
          "id": "10001"
        }
      },
      "customer": {
        "data": {
          "type": "customer",
          "id": "10000"
        }
      }
    }
  }
}

Return ACH payment

Example Request:

curl -X POST 'https://api.s.unit.sh/sandbox/ach/return' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type":"returnAchPayment",
    "relationships": {
      "payment": {
        "data": {
          "type": "achPayment",
          "id": "10"
        }
      }
    }
  }
}'

This API allows you to return an existing ACH payment for testing purposes, the status of payment can either be Clearing or Sent. The Payment Returned and Transaction Created webhook events will be fired.

Verb	`POST`
Url	`https://api.s.unit.sh/sandbox/ach/return`
Data Type	`returnAchPayment`

Relationships

Name	Type	Description
payment	JSON:API Relationship	The ACH Payment to be returned.

Example Response:

{
  "data": {
    "type": "achPayment",
    "id": "10",
    "attributes": {
      "createdAt": "2021-03-09T13:51:51.100Z",
      "amount": 10000,
      "direction": "Debit",
      "description": "Payment from Sandbox",
      "status": "Returned",
      "reason": "R01"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "account",
          "id": "10001"
        }
      },
      "customer": {
        "data": {
          "type": "customer",
          "id": "10000"
        }
      }
    }
  }
}

Receive Wire payment

Example Request:

curl -X POST 'https://api.s.unit.sh/sandbox/wire-payments' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type":"wirePayment",
    "attributes": {
      "amount": 10000,
      "description": "Wire Payment from Sandbox"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "10001"
        }
      }
    }
  }
}'

This API allows you to simulate an incoming wire payment with the specified amount (in cents) for testing purposes. The Transaction Created webhook event will be fired.

Verb	`POST`
Url	`https://api.s.unit.sh/sandbox/wire-payments`
Data Type	`wirePayment`

Attributes

Name	Type	Description
amount	integer	The amount (in cents).
description	string	Payment description (maximum of 50 characters).

Relationships

Name	Type	Description
account	JSON:API Relationship	The Deposit Account receiving the payment.

Example Response:

{
    "data": {
        "type": "wirePayment",
        "id": "108",
        "attributes": {
            "createdAt": "2021-02-24T11:31:10.009Z",
            "amount": 10000,
            "description": "Wire Payment from Sandbox"
        },
        "relationships": {
            "account": {
                "data": {
                    "type": "depositAccount",
                    "id": "10001"
                }
            },
            "customer": {
                "data": {
                    "type": "customer",
                    "id": "10000"
                }
            }
        }
    }
}

Create Card Authorization

curl -X POST 'https://api.s.unit.sh/sandbox/authorizations' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type":"authorization",
    "attributes": {
      "amount": 2500,
      "cardLast4Digits": "0019",
      "merchantName": "Apple Inc.",
      "merchantType": 1000,
      "merchantLocation": "Cupertino, CA",
      "recurring": false
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "10001"
        }
      }
    }
  }
}'

This API allows you to simulate a card purchase authorization with the specified amount (in cents) for testing purposes. The Authorization Created webhook event will be fired.

Verb	`POST`
Url	`https://api.s.unit.sh/sandbox/authorizations`
Data Type	`authorization`

Attributes

Name	Type	Description
amount	integer	The amount (in cents).
cardLast4Digits	string	The last 4 digits of the debit card involved in the authorization.
merchantName	string	The name of the merchant.
merchantType	integer	The 4-digit ISO 18245 merchant category code (MCC). Use any number (e.g. 1000 for testing).
merchantLocation	string	Optional. The location (city, state, etc.) of the merchant.
recurring	boolean	Optional. Default: false. Indicates whether the authorization is recurring

Relationships

Name	Type	Description
account	JSON:API Relationship	The Deposit Account of the customer.

Example Response:

{
  "data": {
    "type": "authorization",
    "id": "125",
    "attributes": {
      "createdAt": "2021-03-01T12:41:15.063Z",
      "amount": 2500,
      "cardLast4Digits": "0019",
      "merchant": {
        "name": "Apple Inc.",
        "type": 1000,
        "category": "",
        "location": "Cupertino, CA"
      }
    },
    "relationships": {
      "customer": {
        "data": {
          "type": "customer",
          "id": "10000"
        }
      },
      "account": {
        "data": {
          "type": "account",
          "id": "10001"
        }
      }
    }
  }
}

Create Card Purchase

curl -X POST 'https://api.s.unit.sh/sandbox/purchases' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type":"purchaseTransaction",
    "attributes": {
      "amount": 1000,
      "direction": "Debit",
      "merchantName": "Apple Inc.",
      "merchantType": 1000,
      "merchantLocation": "Cupertino, CA",
      "coordinates": {
        "longitude": -77.0364,
        "latitude": 38.8951
      },
      "last4Digits": "1234",
      "recurring": false
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "10000"
        }
      }
    }
  }
}'

This API allows you to simulate a card purchase (or a refund) with the specified amount (in cents) for testing purposes. The Transaction Created webhook event will be fired.

Verb	`POST`
Url	`https://api.s.unit.sh/sandbox/purchases`
Data Type	`purchaseTransaction`

Attributes

Name	Type	Description
amount	integer	The amount (in cents).
direction	string	The direction of the purchase- `Debit` for purchase, `Credit` for refund.
merchantName	string	The name of the merchant.
merchantType	integer	The 4-digit ISO 18245 merchant category code (MCC). Use any number (e.g. 1000 for testing).
merchantLocation	string	Optional. The location (city, state, etc.) of the merchant.
coordinates	Coordinates	Optional. Coordinates of the purchase transaction.
last4Digits	string	The last 4 digits of the debit card involved in the purchase
recurring	boolean	Optional. Default: false. Indicates whether the transaction is recurring

Relationships

Name	Type	Description
account	JSON:API Relationship	The Deposit Account of the customer.
authorization	JSON:API Relationship	Optional. Simulates a card purchase with a prior Authorization request (see Authorizations). This will cause the authorization to be removed.

Example Response:

{
  "data": {
    "type": "purchaseTransaction",
    "id": "12",
    "attributes": {
      "createdAt": "2020-10-12T21:22:09.528Z",
      "amount": 2500,
      "direction": "Debit",
      "balance": 148490,
      "merchantName": "Apple Inc.",
      "merchantType": 1000,
      "merchantLocation": "Cupertino, CA",
      "coordinates": {
        "longitude": -77.0364,
        "latitude": 38.8951
      },
      "last4Digits": "1234",
      "recurring": false
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "10001"
        }
      },
      "customer": {
        "data": {
          "type": "customer",
          "id": "2"
        }
      },
      "card": {
        "data": {
          "type": "card",
          "id": "2"
        }
      }
    }
  }
}

Create Card Purchase Reversal

curl -X POST 'https://api.s.unit.sh/sandbox/reversals' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type":"cardReversalTransaction",
    "attributes": {
      "amount": 2500
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "10001"
        }
      },
      "relatedTransaction": {
        "data": {
          "type": "transaction",
          "id": "150"
        }
      }
    }
  }
}'

This API allows you to simulate a Purchase Reversal with the specified amount (in cents) for testing purposes. The Transaction Created webhook event will be fired.

Verb	`POST`
Url	`https://api.s.unit.sh/sandbox/reversals`
Data Type	`cardReversalTransaction`

Attributes

Name	Type	Description
amount	integer	The amount (in cents).

Relationships

Name	Type	Description
account	JSON:API Relationship	The Deposit Account of the customer.
relatedTransaction	JSON:API Relationship	Optional. The Purchase Transaction which the reversal is related to.

Example Response:

{
  "data": {
    "type": "cardReversalTransaction",
    "id": "165",
    "attributes": {
      "createdAt": "2021-03-08T13:05:45.924Z",
      "amount": 2500,
      "balance": 855500
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "10001"
        }
      },
      "customer": {
        "data": {
          "type": "customer",
          "id": "10000"
        }
      },
      "relatedTransaction": {
        "data": {
          "type": "transaction",
          "id": "150"
        }
      }
    }
  }
}

Create ATM Withdrawal

curl -X POST 'https://api.s.unit.sh/sandbox/atm-withdrawals' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type":"atmTransaction",
    "attributes": {
      "amount": 2500,
      "atmName": "HOME FED SAV BK",
      "atmLocation": "Cupertino, CA, US",
      "last4Digits": "1234"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "10001"
        }
      }
    }
  }
}'

This API allows you to simulate an ATM Withdrawal with the specified amount (in cents) for testing purposes. The Transaction Created webhook event will be fired.

Verb	`POST`
Url	`https://api.s.unit.sh/sandbox/atm-withdrawals`
Data Type	`atmTransaction`

Attributes

Name	Type	Description
amount	integer	The amount (in cents).
atmName	string	The name of the ATM.
atmLocation	string	Optional. The location (city, state, etc.) of the ATM.
last4Digits	string	The last 4 digits of the debit card involved in the withdrawal.

Relationships

Name	Type	Description
account	JSON:API Relationship	The Deposit Account of the customer.

Example Response:

{
  "data": {
    "type": "atmTransaction",
    "id": "166",
    "attributes": {
      "createdAt": "2021-03-08T13:18:27.365Z",
      "amount": 2500,
      "balance":855000,
      "atmName": "HOME FED SAV BK",
      "atmLocation": "Cupertino, CA, US",
      "last4Digits": "1234"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "10001"
        }
      },
      "customer": {
        "data": {
          "type": "customer",
          "id": "10000"
        }
      },
      "card": {
        "data": {
          "type": "card",
          "id": "2"
        }
      }
    }
  }
}

Activate Card

Example Request:

curl -X POST 'https://api.s.unit.sh/sandbox/cards/9/activate' \
-H "Authorization: Bearer ${TOKEN}"

Activate a card. The Card Activated webhook event will be fired.

Verb	`POST`
Url	`https://api.s.unit.sh/sandbox/cards/{cardId}/activate`

Generate Account Statement

Example Request:

curl -X POST 'https://api.s.unit.sh/sandbox/accounts/10001/generate-statement' \
-H "Authorization: Bearer ${TOKEN}"

Generate an account statement. The statement includes any transactions performed between the beginning of the current month and up until EOD yesterday. The Statements Created webhook event will be fired.

Verb	`POST`
Url	`https://api.s.unit.sh/sandbox/accounts/{accountId}/generate-statement`

Create Customer Token Without 2FA

Example Request:

curl -X POST 'https://api.s.unit.sh/customers/<CUSTOMER_TOKEN>/token' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type":"customerToken",
    "attributes": {
      "scope": "customers accounts payments payments-create counterparties counterparties-create cards-create",
      "verificationCode": "000001"
    }
  }
}
'

Usually in order to obtain a customer token with write permission we need to perform the following actions:

Create Customer Token Verification
Create Customer Token

For simulation purposes we can skip the 2FA requirement by calling only Create Customer Token passing "verificationCode": "000001".

Create Card Purchase Authorization Request

curl -X POST 'https://api.s.unit.sh/sandbox/authorization-requests/purchase' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{
  "data":{
    "type":"purchaseAuthorizationRequest",
    "attributes": {
      "amount": 2500,
      "merchantName": "Apple Inc.",
      "merchantType": 1000,
      "merchantLocation": "Cupertino, CA",
      "recurring": false
    },
    "relationships": {
      "card": {
        "data": {
          "type": "card",
          "id": "7"
        }
      }
    }

  }
}'

This API allows you to simulate a card purchase authorization request with the specified amount (in cents) for testing purposes. It can be used to test the Programmatic Authorization of Card Purchases functionality, as the Pending Authorization Request webhook event will be fired .

Verb	`POST`
Url	`https://api.s.unit.sh/sandbox/authorization-requests/purchase`
Data Type	`purchaseAuthorizationRequest`

Attributes

Name	Type	Description
amount	integer	The amount (in cents).
merchantName	string	The name of the merchant.
merchantType	integer	The 4-digit ISO 18245 merchant category code (MCC). Use any number (e.g. 1000 for testing).
merchantLocation	string	Optional. The location (city, state, etc.) of the merchant.
recurring	boolean	Optional. Default: false. Indicates whether the authorization is recurring

Relationships

Name	Type	Description
card	JSON:API Relationship	The debit card used in the purchase.

Example Response:

{
  "data": {
    "type": "purchaseAuthorizationRequest",
    "id": "5",
    "attributes": {
      "createdAt": "2021-06-24T08:07:22.520Z",
      "amount": 2500,
      "status": "Pending",
      "partialApprovalAllowed": false,
      "merchant": {
        "name": "Apple Inc.",
        "type": 1000,
        "category": "",
        "location": "Cupertino, CA"
      },
      "recurring": false
    },
    "relationships": {
      "customer": {
        "data": {
          "type": "customer",
          "id": "10000"
        }
      },
      "account": {
        "data": {
          "type": "account",
          "id": "10001"
        }
      },
      "card": {
        "data": {
          "type": "card",
          "id": "7"
        }
      }
    }
  }
}

Transmit Check Deposit

Example Request:

curl -X POST 'https://api.s.unit.sh/sandbox/check-deposits/122/transmit' \
-H "Authorization: Bearer ${TOKEN}"

This API allows you to simulate a file transmission to the network for an existing Check Deposit with Pending status. After transmission, the status would change to Clearing. The Check Deposit Clearing webhook event will be fired.

Verb	`POST`
Url	`https://api.s.unit.sh/sandbox/check-deposits/{checkDepositId}/transmit`

Clear Check Deposit

Example Request:

curl -X POST 'https://api.s.unit.sh/sandbox/check-deposits/122/clear' \
-H "Authorization: Bearer ${TOKEN}"

This API allows you to immediately clear an existing Check Deposit with Clearing status without waiting for the end of the clearing period. The Check Deposit Sent and the Transaction Created webhook events will be fired.

Verb	`POST`
Url	`https://api.s.unit.sh/sandbox/check-deposits/{checkDepositId}/clear`

Return Check Deposit

Example Request:

curl -X POST 'https://api.s.unit.sh/sandbox/check-deposits/122/return' \
-H "Authorization: Bearer ${TOKEN}"

This API allows you to return an existing Check Deposit with Sent status, for testing purposes. The Check Deposit Returned and the Transaction Created webhook events will be fired.

Verb	`POST`
Url	`https://api.s.unit.sh/sandbox/check-deposits/{checkDepositId}/return`

Statements

An account statement is a list of all transactions for an account over a monthly period. The statement includes deposits, charges and withdrawals, as well as the starting and ending balance for the period.

Account-holders generally review their bank statements every month to help keep track of expenses and spending, as well as monitor for any fraudulent charges or mistakes. It is required, by regulation, that an account statement is available to all account owners.

Unit provides white-labeled HTML based account statements, supporting all browsers, devices and standard screen resolutions, and eliminating any need for custom development work on your side.

List

List statement resources. Filtering and paging can be applied.

curl -X GET 'https://api.s.unit.sh/statements?page[limit]=20&page[offset]=10' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/statements`
Required Scope	`statements`

Query Parameters

Name	Type	Default	Description
page[limit]	integer	100	Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
page[offset]	integer	0	Number of resources to skip. See Pagination.
filter[accountId]	string	(empty)	Optional. Filters the results by the specified account id.
filter[customerId]	string	(empty)	Optional. Filters the results by the specified customer id.

Response

Example Response:

{
  "data": [
    {
      "type": "statement",
      "id": "1",
      "attributes": {
        "period": "2020-07"
      },
      "relationships": {
        "account": {
          "data": {
            "type": "account",
            "id": "1000"
          }
        },
        "customer": {
          "data": {
            "type": "customer",
            "id": "1"
          }
        }
      }
    },
    {
      "type": "statement",
      "id": "2",
      "attributes": {
        "period": "2020-08"
      },
      "relationships": {
        "account": {
          "data": {
            "type": "account",
            "id": "1000"
          }
        },
        "customer": {
          "data": {
            "type": "customer",
            "id": "1"
          }
        }
      }
    }
  ]
}

Response is a JSON:API document.

200 OK

Field	Type	Description
data	Array of Statement	Array of statement resources.

Get HTML by Id

Get a statement HTML output by id.

curl -X GET 'https://api.s.unit.sh/statements/1/html' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/statements/{id}/html`
Required Scope	`statements`

Query Parameters

Name	Type	Default	Description
filter[customerId]	string	(empty)	Optional. Verify that the statements belongs to the customer.

Response

Response is a HTML document.

Events

Unit uses Events to record important changes happening under your org. Once an event is created, it will be delivered to your application via a webhook call.

Our event types follow a specific structure: resource.event.

Each event includes an id field, which uniquely identifies the event instance, and a type field that identifies the type of the event instance.

Each event type includes a different set of attributes and relationships, relevant to that specific event.

Event attributes may contain a set of custom tags inherited from a related resource request.

account.closed

Example account.closed payload:

{
  "data": [
    {
      "id": "269",
      "type": "account.closed",
      "attributes": {
        "createdAt": "2021-04-13T07:40:43.813Z",
        "closeReason": "ByCustomer",
        "tags":{
            "tag": "value"
        }
      },
      "relationships": {
        "account": {
          "data": {
            "id": "10004",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "10000",
            "type": "customer"
          }
        }
      }
    }
  ]
}

Occurs when a Deposit Account is closed.

application.denied

Example application.denied payload:

{
  "data": [
    {
      "id": "28",
      "type": "application.denied",
      "attributes": {
        "createdAt": "2020-07-29T12:53:05.882Z",
        "tags":{
            "tag": "value"
        }
      },
      "relationships": {        
        "application": {
          "data": {
            "id": "52",
            "type": "individualApplication"
          }
        }
      }
    }
  ]
}

Occurs when an Application is denied.

application.pendingReview

Example application.pendingReview payload:

{
  "data": [
    {
      "id": "28",
      "type": "application.pendingReview",
      "attributes": {
        "createdAt": "2020-07-29T12:53:05.882Z",
        "tags":{
            "tag": "value"
        }
      },
      "relationships": {        
        "application": {
          "data": {
            "id": "52",
            "type": "individualApplication"
          }
        }
      }
    }
  ]
}

Occurs when an Application is in pendingReview state.

application.awaitingDocuments

Example application.awaitingDocuments payload:

{
  "data": [
    {
      "id": "3000",
      "type": "application.awaitingDocuments",
      "attributes": {
        "createdAt": "2020-07-29T12:53:05.882Z",
        "tags":{
            "tag": "value"
        }
      },
      "relationships": {        
        "application": {
          "data": {
            "id": "87",
            "type": "individualApplication"
          }
        }
      }
    }
  ]
}

Occurs when additional Application Documents are required to approve an Application.

authorization.created

Example authorization.created payload:

{
  "data": [
    {
      "id": "83",
      "type": "authorization.created",
      "attributes": {
        "createdAt": "2021-02-21T07:31:18.692Z",
        "cardLast4Digits": "0019",
        "recurring": false,
        "tags":{
            "tag": "value"
        }
      },
      "relationships": {
        "authorization": {
          "data": {
            "id": "98",
            "type": "authorization"
          }
        },
        "account": {
          "data": {
            "id": "10001",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "10000",
            "type": "customer"
          }
        }
      }
    }
  ]
}

Occurs when an Authorization is created.

authorizationRequest.approved

Example authorizationRequest.approved payload:

{
  "data": [
    {
      "id": "412",
      "type": "authorizationRequest.approved",
      "attributes": {
        "createdAt": "2021-06-24T08:10:08.081Z",
        "amount": 2000,
        "status": "Approved",
        "approvedAmount": 2000,
        "partialApprovalAllowed": false,
        "merchant": {
          "name": "Merchant name",
          "type": "6012"
        },
        "recurring": false,
        "tags":{
            "tag": "value"
        }
      },
      "relationships": {
        "authorizationRequest": {
          "data": {
            "id": "6",
            "type": "purchaseAuthorizationRequest"
          }
        },
        "account": {
          "data": {
            "id": "10001",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "10000",
            "type": "customer"
          }
        },
        "card": {
          "data": {
            "id": "7",
            "type": "card"
          }
        }
      }
    }
  ]
}

Occurs when an AuthorizationRequest is approved. See Programmatic authorization of card purchases

authorizationRequest.declined

Example authorizationRequest.declined payload:

{
  "data": [
    {
      "id": "412",
      "type": "authorizationRequest.declined",
      "attributes": {
        "createdAt": "2021-06-24T08:10:08.081Z",
        "amount": 2000,
        "status": "Declined",
        "declineReason": "InsufficientFunds",
        "partialApprovalAllowed": false,
        "merchant": {
          "name": "Merchant name",
          "type": "6012"
        },
        "recurring": false,
        "tags":{
            "tag": "value"
        }
      },
      "relationships": {
        "authorizationRequest": {
          "data": {
            "id": "6",
            "type": "purchaseAuthorizationRequest"
          }
        },
        "account": {
          "data": {
            "id": "10001",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "10000",
            "type": "customer"
          }
        },
        "card": {
          "data": {
            "id": "7",
            "type": "card"
          }
        }
      }
    }
  ]
}

Occurs when an AuthorizationRequest is declined. See Programmatic authorization of card purchases

authorizationRequest.pending

Example authorizationRequest.pending payload:

{
  "data": [
    {
      "id": "412",
      "type": "authorizationRequest.pending",
      "attributes": {
        "createdAt": "2021-06-24T08:10:08.081Z",
        "amount": 2000,
        "status": "Pending",
        "partialApprovalAllowed": false,
        "merchant": {
          "name": "Merchant name",
          "type": "6012"
        },
        "recurring": false,
        "tags":{
            "tag": "value"
        }
      },
      "relationships": {
        "authorizationRequest": {
          "data": {
            "id": "6",
            "type": "purchaseAuthorizationRequest"
          }
        },
        "account": {
          "data": {
            "id": "10001",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "10000",
            "type": "customer"
          }
        },
        "card": {
          "data": {
            "id": "7",
            "type": "card"
          }
        }
      }
    }
  ]
}

Occurs when an AuthorizationRequest is pending approval. See Programmatic authorization of card purchases

card.activated

Example card.activated payload:

{
  "data": [
    {
      "id": "73",
      "type": "card.activated",
      "attributes": {
        "createdAt": "2021-02-15T09:23:47.778Z",
        "tags":{
            "tag": "value"
        }
      },
      "relationships": {
        "card": {
          "data": {
            "id": "6",
            "type": "individualDebitCard"
          }
        },
        "account": {
          "data": {
            "id": "10001",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "10000",
            "type": "customer"
          }
        }
      }
    }
  ]
}

Occurs when a Card is activated for the first time.

card.statusChanged

Example card.statusChanged payload:

{
  "data": [
    {
      "id": "74",
      "type": "card.statusChanged",
      "attributes": {
        "createdAt": "2021-02-22T09:23:47.778Z",
        "newStatus": "Lost",
        "previousStatus": "Active",
        "tags":{
            "tag": "value"
        }
      },
      "relationships": {
        "card": {
          "data": {
            "id": "6",
            "type": "individualDebitCard"
          }
        },
        "account": {
          "data": {
            "id": "10001",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "10000",
            "type": "customer"
          }
        }
      }
    }
  ]
}

Occurs when a Card status changes, excluding first time card activation (see card.activated).

checkDeposit.created

Example checkDeposit.created payload:

{
  "data": [
    {
      "id": "382",
      "type": "checkDeposit.created",
      "attributes": {
        "createdAt": "2021-06-06T09:09:15.247Z",
        "status": "AwaitingImages"
      },
      "relationships": {
        "checkDeposit": {
          "data": {
            "id": "122",
            "type": "checkDeposit"
          }
        },
        "account": {
          "data": {
            "id": "10001",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "10000",
            "type": "customer"
          }
        }
      }
    }
  ]
}

Occurs when a Check Deposit is created.

checkDeposit.clearing

Example checkDeposit.clearing payload:

{
  "data": [
    {
      "id": "376",
      "type": "checkDeposit.clearing",
      "attributes": {
        "createdAt": "2021-06-06T07:21:39.509Z",
        "previousStatus": "Pending"
      },
      "relationships": {
        "checkDeposit": {
          "data": {
            "id": "122",
            "type": "checkDeposit"
          }
        },
        "account": {
          "data": {
            "id": "10001",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "10000",
            "type": "customer"
          }
        }
      }
    }
  ]
}

Occurs when a Check Deposit is in the process of being cleared.

checkDeposit.sent

Example checkDeposit.sent payload:

{
  "data": [
    {
      "id": "376",
      "type": "checkDeposit.sent",
      "attributes": {
        "createdAt": "2021-06-06T07:21:39.509Z",
        "previousStatus": "Clearing"
      },
      "relationships": {
        "checkDeposit": {
          "data": {
            "id": "122",
            "type": "checkDeposit"
          }
        },
        "account": {
          "data": {
            "id": "10001",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "10000",
            "type": "customer"
          }
        }
      }
    }
  ]
}

Occurs when a Check Deposit was processed.

checkDeposit.returned

Example checkDeposit.returned payload:

{
  "data": [
    {
      "id": "376",
      "type": "checkDeposit.returned",
      "attributes": {
        "createdAt": "2021-06-06T07:21:39.509Z",
        "previousStatus": "Sent"
      },
      "relationships": {
        "checkDeposit": {
          "data": {
            "id": "122",
            "type": "checkDeposit"
          }
        },
        "account": {
          "data": {
            "id": "10001",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "10000",
            "type": "customer"
          }
        }
      }
    }
  ]
}

Occurs when a Check Deposit was returned.

customer.created

Example customer.created payload:

{
  "data": [
    {
      "id": "28",
      "type": "customer.created",
      "attributes": {
        "createdAt": "2020-07-29T12:53:05.882Z",
        "tags":{
            "tag": "value"
        }
      },
      "relationships": {
        "customer": {
          "data": {
            "id": "52",
            "type": "individualCustomer"
          }
        },
        "application": {
          "data": {
            "id": "52",
            "type": "individualApplication"
          }
        }
      }
    }
  ]
}

Occurs when a new Customer is created.

document.approved

Example document.approved payload:

{
  "data": [
    {
      "id": "193",
      "type": "document.approved",
      "attributes": {
        "createdAt": "2020-11-09T09:05:49.999Z",
        "tags":{
            "tag": "value"
        }
      },
      "relationships": {
        "document": {
          "data": {
            "id": "6",
            "type": "document"
          }
        },
        "application": {
          "data": {
            "id": "10009",
            "type": "individualApplication"
          }
        }
      }
    }
  ]
}

Occurs when an Application Document is approved.

document.rejected

Example document.rejected payload:

{
  "data": [
    {
      "id": "190",
      "type": "document.rejected",
      "attributes": {
        "reason": "blurry image",
        "reasonCode": "PoorQuality",
        "createdAt": "2020-11-08T18:34:38.533Z",
        "tags":{
            "tag": "value"
        }
      },
      "relationships": {
        "document": {
          "data": {
            "id": "6",
            "type": "document"
          }
        },
        "application": {
          "data": {
            "id": "10009",
            "type": "individualApplication"
          }
        }
      }
    }
  ]
}

Occurs when an Application Document is rejected.

payment.clearing

Example payment.clearing payload:

{
  "data": [
    {
      "id": "290",
      "type": "payment.clearing",
      "attributes": {
        "previousStatus": "Pending",
        "createdAt": "2020-11-08T18:34:38.533Z",
        "tags":{
            "tag": "value"
        }
      },
      "relationships": {
        "payment": {
          "data": {
            "id": "6",
            "type": "payment"
          }
        },
        "account": {
          "data": {
            "id": "10009",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "10002",
            "type": "customer"
          }
        }
      }
    }
  ]
}

Occurs when an originated Debit ACH Payment was delivered to the ACH network, but the account was not credited yet.

payment.sent

Example payment.sent payload:

{
  "data": [
    {
      "id": "291",
      "type": "payment.sent",
      "attributes": {
        "previousStatus": "Pending",
        "createdAt": "2020-11-08T18:34:38.533Z",
        "tags":{
            "tag": "value"
        }
      },
      "relationships": {
        "payment": {
          "data": {
            "id": "8",
            "type": "payment"
          }
        },
        "account": {
          "data": {
            "id": "10009",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "10002",
            "type": "customer"
          }
        }
      }
    }
  ]
}

Occurs when an originated ACH Payment was processed by the ACH network.

payment.returned

Example payment.returned payload:

{
  "data": [
    {
      "id": "295",
      "type": "payment.returned",
      "attributes": {
        "previousStatus": "Sent",
        "createdAt": "2021-01-02T13:38:28.223Z",
        "tags":{
            "tag": "value"
        }
      },
      "relationships": {
        "payment": {
          "data": {
            "id": "10",
            "type": "payment"
          }
        },
        "account": {
          "data": {
            "id": "10009",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "10002",
            "type": "customer"
          }
        }
      }
    }
  ]
}

Occurs when a sent ACH Payment was returned by the ACH network or the receiving bank.

statements.created

Example statements.created payload:

{
  "data": [
    {
      "id": "241",
      "type": "statements.created",
      "attributes": {
        "createdAt": "2021-03-01T00:16:28.911Z",
        "period": "2021-02",
        "tags":{
            "tag": "value"
        }
      }
    }
  ]
}

Occurs when all Statements were created for the previous month.

transaction.created

Example transaction.created payload:

{
  "data": [
    {
      "id": "34",
      "type": "transaction.created",
      "attributes": {
        "summary": "Funding",
        "direction": "Debit",        
        "amount": "2500",
        "createdAt": "2020-07-30T09:17:21.593Z",
        "tags":{
            "tag": "value"
        }
      },
      "relationships": {
        "transaction": {
          "data": {
            "type": "receivedAch",
            "id": "10001" 
          }   
        },
        "account": {
          "data": {
            "id": "1000",
            "type": "account"
          }
        },
        "customer": {
          "data": {
            "id": "1",
            "type": "customer"
          }
        },
        "payment": {
          "data": {
            "id": "515",
            "type": "payment"
          }
        }
      }
    }
  ]
}

Occurs when a Transaction is created.

Get by Id

Get an event resource by id.

curl -X GET 'https://api.s.unit.sh/events/10' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/events/{id}`
Required Scope	`events`

Response

Response is a JSON:API document.

200 OK

Field	Type	Description
data	Event	The requested resource after the operation was completed.

List

List event resources. Paging can be applied.

curl -X GET 'https://api.s.unit.sh/events?page[limit]=20&page[offset]=10' \
-H "Authorization: Bearer ${TOKEN}"

Verb	`GET`
Url	`https://api.s.unit.sh/events`
Required Scope	`events`

Query Parameters

Name	Type	Default	Description
page[limit]	integer	100	Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
page[offset]	integer	0	Number of resources to skip. See Pagination.
filter[type][]	string	(empty)	Optional. Filter Events by Event type.

Response

Example Response:

{
  "data": [
    {
      "id": "231",
      "type": "customer.created",
      "attributes": {
        "createdAt": "2021-03-15T12:20:39.216Z"
      },
      "relationships": {
        "customer": {
          "data": {
            "id": "10004",
            "type": "businessCustomer"
          }
        }
      }
    },
    {
      "id": "230",
      "type": "transaction.created",
      "attributes": {
        "createdAt": "2021-03-15T07:49:09.089Z",
        "amount": 10000,
        "direction": "Credit",
        "summary": "Wire from Sender"
      },
      "relationships": {
        "account": {
          "data": {
            "id": "10005",
            "type": "account"
          }
        },
        "transaction": {
          "data": {
            "id": "189",
            "type": "wireTransaction"
          }
        },
        "customer": {
          "data": {
            "id": "10000",
            "type": "individualCustomer"
          }
        }
      }
    }
  ]
}

Response is a JSON:API document.

200 OK

Field	Type	Description
data	Array of Event	Array of event resources.

Fire Event

Example Request:

curl -X POST 'https://api.s.unit.sh/events/78' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Authorization: Bearer ${TOKEN}' \
--data-raw '{}'

Resend a previously published webhook event.

Verb	`POST`
Url	`https://api.s.unit.sh/events/{eventId}`
Required Scope	`events-write`

Resources

IndividualApplication

Example IndividualApplication resource:

{
  "type": "individualApplication",
  "id": "53",
  "attributes": {
    "createdAt": "2020-01-14T14:05:04.718Z",
    "fullName": {
      "first": "Peter",
      "last": "Parker"
    },
    "ssn": "721074426",
    "address": {
      "street": "20 Ingram St",
      "street2": null,
      "city": "Forest Hills",
      "state": "NY",
      "postalCode": "11375",
      "country": "US"
    },
    "dateOfBirth": "2001-08-10",
    "email": "peter@oscorp.com",
    "phone": {
      "countryCode": "1",
      "number": "1555555578"
    },
    "status": "AwaitingDocuments",
    "message": "Waiting for you to upload the required documents.",
    "tags": {
      "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
    }
  },
  "relationships": {
    "org": {
      "data": {
        "type": "org",
        "id": "1"
      }
    },
    "documents": {
      "data": [
        {
          "type": "document",
          "id": "1"
        },
        {
          "type": "document",
          "id": "2"
        }
      ]
    }
  }
}

IndividualApplication is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the application resource.
type	string	Type of the application resource. For individual application the value is always `individualApplication`.
attributes	JSON Object	JSON object representing the application data.
relationships	JSON:API Relationships	Describes relationships between the application resource and other resources (documents).

Attributes

Field	type	Description
status	string	One of `AwaitingDocuments`, `PendingReview`, `Approved`, `Denied` or `Pending`, see Application Statuses.
message	string	A message describing the `IndividualApplication` status.
createdAt	RFC3339 Date string	The date the resource was created.
ssn	string	SSN of the individual (numbers only). Either `ssn` or `passport` will be populated.
passport	string	Individual passport number. Either `ssn` or `passport` will be populated.
nationality	ISO31661-Alpha2 string	Only when Passport is populated. Two letters representing the individual nationality (e.g. `"US"`).
fullName	FullName	Full name of the individual.
dateOfBirth	RFC3339 Date string	Date only (e.g. `"2001-08-15"`).
address	Address	Address of the individual.
phone	Phone	Phone of the individual.
email	string	Email address of the individual.
ip	string	IP address of the end-customer creating the application, if specified.
soleProprietorship	boolean	Optional. Indicates whether the individual is a sole proprietor, if specified.
ein	string	Optional. Indicates if the individual is a sole proprietor who has an Employer Identification Number, if specified.
dba	string	Optional. Indicates if the individual is a sole proprietor who is doing business under a different name, if specified.
tags	object	See Tags.

Relationships

Field	type	Description
documents	Array of JSON:API Relationship	Application's documents.
customer	JSON:API Relationship	Optional. The created `Customer` in case of approved application.

BusinessApplication

Example BusinessApplication resource:

{
  "type": "businessApplication",
  "id": "50",
  "attributes": {
    "createdAt": "2020-01-13T16:01:19.346Z",
    "name": "Pied Piper",
    "dba": null,
    "address": {
      "street": "5230 Newell Rd",
      "street2": null,
      "city": "Palo Alto",
      "state": "CA",
      "postalCode": "94303",
      "country": "US"
    },
    "phone": {
      "countryCode": "1",
      "number": "1555555578"
    },
    "stateOfIncorporation": "DE",
    "ein": "123456789",
    "entityType": "Corporation",
    "contact": {
      "fullName": {
        "first": "Richard",
        "last": "Hendricks"
      },
      "email": "richard@piedpiper.com",
      "phone": {
        "countryCode": "1",
        "number": "1555555578"
      }
    },
    "officer": {
      "fullName": {
        "first": "Richard",
        "last": "Hendricks"
      },
      "ssn": "123456789",
      "address": {
        "street": "5230 Newell Rd",
        "street2": null,
        "city": "Palo Alto",
        "state": "CA",
        "postalCode": "94303",
        "country": "US"
      },
      "dateOfBirth": "2001-08-10",
      "email": "richard@piedpiper.com",
      "phone": {
        "countryCode": "1",
        "number": "1555555589"
      },
      "status": "Approved"
    },
    "beneficialOwners": [
      {
        "fullName": {
          "first": "Richard",
          "last": "Hendricks"
        },
        "ssn": "123456789",
        "address": {
          "street": "5230 Newell Rd",
          "street2": null,
          "city": "Palo Alto",
          "state": "CA",
          "postalCode": "94303",
          "country": "US"
        },
        "dateOfBirth": "2001-08-10",
        "phone": {
          "countryCode": "1",
          "number": "1555555589"
        },
        "email": "richard@piedpiper.com",
        "status": "Approved"
      }
    ],
    "tags": {
      "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
    },
    "status": "AwaitingDocuments",
    "message": "Waiting for you to upload the required documents."
  },
  "relationships": {
    "org": {
      "data": {
        "type": "org",
        "id": "1"
      }
    },
    "documents": {
      "data": [
        {
          "type": "document",
          "id": "1"
        },
        {
          "type": "document",
          "id": "2"
        },
        {
          "type": "document",
          "id": "3"
        }
      ]
    }
  }
}

BusinessApplication is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the application resource.
type	string	Type of the application resource, for business application the value is always `businessApplication`.
attributes	JSON Object	JSON object representing the application data.
relationships	JSON:API Relationships	Describes relationships between the application resource and other resources (documents).

Attributes

Field	type	Description
status	string	One of `AwaitingDocuments`, `PendingReview`, `Approved`, `Denied` or `Pending`, see Application Statuses.
message	string	A message describing the `BusinessApplication` status.
createdAt	RFC3339 Date string	The date the resource was created.
name	string	Name of the business.
dba	string	Optional. “Doing business as”.
address	Address	Address of the business.
phone	Phone	Phone of the business.
stateOfIncorporation	string	Two letters representing a US state.
ein	string	Business EIN (numbers only).
entityType	string	One of `"Corporation"`, `"LLC"` or `"Partnership"`.
contact	BusinessContact	Primary contact of the business.
officer	Officer	Officer representing the business, must be CEO, CFO, President or BenefitsAdministrationOfficer. The officer would need to go over KYC process and provide documents.
beneficialOwners	Array of BeneficialOwner	Array of beneficial owners of the business. Beneficial Owner is anyone with more than 25% ownership. Beneficial Owners would need to go over KYC process and provide documents.
tags	object	See Tags.

Relationships

Field	type	Description
documents	Array of JSON:API Relationship	Application's documents.
customer	JSON:API Relationship	Optional. The created `Customer` in case of approved application.

ApplicationDocument

Example ApplicationDocument resource:

{
    "type": "document",
    "id": "3",
    "attributes": {
        "documentType": "IdDocument",
        "status": "Approved",
        "description": "Please provide a copy of your unexpired government issued photo ID which would include Drivers License or State ID.",
        "name": "Richard Hendricks",
        "dateOfBirth": "2001-08-15"
    }
}

ApplicationDocument is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the document resource.
type	string	Always `document`.
attributes	JSON Object	JSON object representing the document’s data.

Attributes

Field	type	Description
status	string	One of `Required`, `ReceivedBack`, `ReceivedFront`, `Invalid`, `Approved` or `PendingReview`, see Application Document Status.
documentType	string	One of `IdDocument`, `Passport`, `AddressVerification`, `CertificateOfIncorporation` or `EmployerIdentificationNumberConfirmation`.
description	string	The document requirements description.
name	string	Name of business or individual.
address	Address	Individual address, present only for the `AddressVerification` document type.
dateOfBirth	RFC3339 Date string	Date only (e.g. `"2001-08-15"`). Present only for `Passport` and `License` document types.
passport	string	Individual passport number. Present only for the `Passport` document type.
ein	string	Business EIN. Present only for the `EmployerIdentificationNumberConfirmation` document type.
reasonCode	string	Application Document rejection reason code. Present only when document status is `Invalid`. One of `PoorQuality`, `NameMismatch`, `SSNMismatch`, `AddressMismatch`, `DOBMismatch`, `ExpiredId`, `EINMismatch`, `StateMismatch`, `Other`.
reason	string	Application Document rejection reason. Present only when document status is `Invalid`.

IndividualCustomer

Example IndividualCustomer resource:

{
  "type": "individualCustomer",
  "id": "8",
  "attributes": {
    "createdAt": "2020-05-12T19:41:04.123Z",
    "fullName": {
      "first": "Peter",
      "last": "Parker"
    },
    "ssn": "721074426",
    "address": {
      "street": "20 Ingram St",
      "street2": null,
      "city": "Forest Hills",
      "state": "NY",
      "postalCode": "11375",
      "country": "US"
    },
    "dateOfBirth": "2001-08-10",
    "email": "peter@oscorp.com",
    "phone": {
      "countryCode": "1",
      "number": "1555555578"
    },
    "tags": {
      "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
    }
  },
  "relationships": {
    "org": {
      "data": {
        "type": "org",
        "id": "1"
      }
    },
    "application": {
      "data": {
        "type": "individualApplication",
        "id": "8"
      }
    }
  }
}

IndividualCustomer is a JSON:API resource, describing the individual customer. Top-level fields:

Field	type	Description
id	string	Identifier of the individual resource.
type	string	Type of the resource, the value is always `individualCustomer`.
attributes	JSON Object	JSON object representing the individual data.
relationships	JSON:API Relationships	Describes relationships between the customer resource, the `Org` it belongs to, and the `Application` it was created by.

Field	type	Description
createdAt	RFC3339 Date string	The date the resource was created.
ssn	string	Individual passport number. Either `ssn` or `passport` will be populated.
passport	string	Individual passport number. Either `ssn` or `passport` will be populated.
nationality	ISO31661-Alpha2 string	Only when Passport is populated. Two letters representing the individual nationality (e.g. `"US"`).
fullName	FullName	Full name of the individual.
dateOfBirth	RFC3339 Date string	Date only (e.g. `"2001-08-15"`).
address	Address	Address of the individual.
phone	Phone	Phone of the individual.
email	string	Email address of the individual.
tags	object	See Tags.

Relationships

Name	Type	Description
org	JSON:API Relationship	The `Org` of the individual.
application	JSON:API Relationship	The `Application` that created this individual.

BusinessCustomer

Example BusinessCustomer resource:

{
  "type": "businessCustomer",
  "id": "1",
  "attributes": {
    "createdAt": "2020-05-10T12:28:37.698Z",
    "name": "Pied Piper",
    "address": {
      "street": "5230 Newell Rd",
      "street2": null,
      "city": "Palo Alto",
      "state": "CA",
      "postalCode": "94303",
      "country": "US"
    },
    "phone": {
      "countryCode": "1",
      "number": "1555555578"
    },
    "stateOfIncorporation": "DE",
    "ein": "123456789",
    "entityType": "Corporation",
    "contact": {
      "fullName": {
        "first": "Richard",
        "last": "Hendricks"
      },
      "email": "richard@piedpiper.com",
      "phone": {
        "countryCode": "1",
        "number": "1555555578"
      }
    },
    "authorizedUsers": [
      {
        "fullName": {
          "first": "Jared",
          "last": "Dunn"
        },
        "email": "jared@piedpiper.com",
        "phone": {
          "countryCode": "1",
          "number": "1555555590"
        }
      }
    ],
    "tags": {
      "userId": "106a75e9-de77-4e25-9561-faffe59d7814"
    }
  },
  "relationships": {
    "org": {
      "data": {
        "type": "org",
        "id": "1"
      }
    },
    "application": {
      "data": {
        "type": "businessApplication",
        "id": "1"
      }
    }
  }
}

BusinessCustomer is a JSON:API resource, describing the business customer. Top-level fields:

Field	type	Description
id	string	Identifier of the business resource.
type	string	Type of the resource, the value is always `businessCustomer`.
attributes	JSON Object	JSON object representing the business data.
relationships	JSON:API Relationships	Describes relationships between the customer resource, the `Org` it belongs to, and the `Application` it was created by.

Attributes

Field	type	Description
createdAt	RFC3339 Date string	The date the resource was created.
name	string	Name of the business.
dba	string	Optional. “Doing business as”.
address	Address	Address of the business.
phone	Phone	Phone of the business.
stateOfIncorporation	string	Two letters representing a US state.
ein	string	Business EIN (numbers only).
entityType	string	One of `"Corporation"` or `"LLC"`.
contact	BusinessContact	Primary contact of the business.
authorizedUsers	Array of AuthorizedUser	Array of authorized users. An authorized user is someone who can participate in the One Time Password (OTP) authentication process.
tags	object	See Tags. Inherited from the application tags (see Tag Inheritance).

Relationships

Name	Type	Description
org	JSON:API Relationship	The `Org` of the business.
application	JSON:API Relationship	The `Application` that created this business.

DepositAccount

Example DepositAccount Resource:

{
  "type": "depositAccount",
  "id": "1",
  "attributes": {
    "createdAt": "2000-05-11T10:19:30.409Z",
    "name": "Peter Parker",
    "status": "Open",
    "depositProduct": "checking",
    "routingNumber": "812345678",
    "accountNumber": "1000000002",
    "currency": "USD",
    "balance": 10000,
    "hold": 0,
    "available": 10000,
    "tags": {
      "purpose": "checking"
    }
  },
  "relationships": {
    "customer": {
      "data": {
        "type": "customer",
        "id": "45555"
      }
    }
  }
}

DepositAccount is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the deposit account resource.
type	string	Type of the resource, the value is always `depositAccount`.
attributes	JSON Object	JSON object representing the deposit account data.
relationships	JSON:API Relationships	Describes relationships between the deposit account resource and the customer.

Attributes

Name	Type	Description
createdAt	RFC3339 Date string	The date the resource was created.
name	string	Name of the account holder.
depositProduct	string	The name of the deposit product.
routingNumber	string	Routing number of account.
accountNumber	string	Account number, together with the `routingNumber` forms the identifier of the account on the ACH network.
currency	string	Currency of the account.
balance	integer	The balance amount (in cents).
hold	integer	The hold amount (in cents).
available	integer	The available balance for spending (in cents).
tags	object	See Tags.
status	string	Status of the account, either `Open` or `Closed`.

Note: the currency is currently always set to USD. The balance is represented in cents.

Relationships

Name	Type	Description
customer	JSON:API Relationship	The customer.

IndividualDebitCard

Example IndividualDebitCard resource:

{
  "type": "individualDebitCard",
  "id": "8",
  "attributes": {
    "createdAt": "2020-05-13T09:07:47.645Z",
    "last4Digits": "1234",
    "expirationDate": "2022-05",
    "shippingAddress": {
      "street": "5230 Newell Rd",
      "street2": null,
      "city": "Palo Alto",
      "state": "CA",
      "postalCode": "94303",
      "country": "US"
    },
    "status": "Active"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "depositAccount",
        "id": "2"
      }
    },
    "customer": {
      "data": {
        "type": "individualCustomer",
        "id": "2"
      }
    }
  }
}

IndividualDebitCard is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the card resource.
type	string	Type of the card resource. For individual debit card the value is always `individualDebitCard`.
attributes	JSON Object	JSON object representing the card data.
relationships	JSON:API Relationships	Describes relationships between the card resource and other resources (account and customer).

Attributes

Field	type	Description
createdAt	RFC3339 Date string	The date the resource was created.
last4Digits	string	Last 4 digits of the debit card.
expirationDate	string	Card expiration date, formatted `YYYY-MM`, e.g `"2020-05"`.
shippingAddress	Address	Optional. Shipping address, if specified.
status	string	Status of the card, one of: `Active`, `Inactive`, `Stolen`, `Lost`, `Frozen`, `ClosedByCustomer`, `SuspectedFraud`.
design	string	Optional. Card design, if specified.

Relationships

Field	type	Description
account	JSON:API Relationship	The account the card belongs to.
customer	JSON:API Relationship	The individual or business customer the card belongs to.

BusinessDebitCard

Example BusinessDebitCard resource:

{
  "type": "businessDebitCard",
  "id": "9",
  "attributes": {
    "createdAt": "2020-05-13T09:42:21.857Z",
    "last4Digits": "2074",
    "expirationDate": "2022-05",
    "shippingAddress": {
      "street": "5230 Newell Rd",
      "street2": null,
      "city": "Palo Alto",
      "state": "CA",
      "postalCode": "94303",
      "country": "US"
    },
    "address": {
      "street": "5230 Newell Rd",
      "street2": null,
      "city": "Palo Alto",
      "state": "CA",
      "postalCode": "94303",
      "country": "US"
    },
    "fullName": {
      "first": "Richard",
      "last": "Hendricks"
    },
    "phone": {
      "countryCode": "1",
      "number": "1555555578"
    },
    "email": "richard@piedpiper.com",
    "dateOfBirth": "2001-08-10",
    "ssn": "123456789",
    "status": "Active"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "depositAccount",
        "id": "1"
      }
    },
    "customer": {
      "data": {
        "type": "businessCustomer",
        "id": "1"
      }
    }
  }
}

BusinessDebitCard is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the card resource.
type	string	Type of the card resource. For business debit card the value is always `BusinessDebitCard`.
attributes	JSON Object	JSON object representing the card data.
relationships	JSON:API Relationships	Describes relationships between the card resource and other resources (account and customer).

Attributes

Field	type	Description
createdAt	RFC3339 Date string	The date the resource was created.
last4Digits	string	Last 4 digits of the debit card.
expirationDate	string	Card expiration date, formatted `YYYY-MM`, e.g `"2020-05"`.
shippingAddress	Address	Optional. Shipping address, if specified.
ssn	string	SSN of the card holder (numbers only). Either an SSN or a passport number is required.
passport	string	Passport number of the card holder. Either an SSN or a passport is required.
nationality	ISO31661-Alpha2 string	Only when Passport is populated. Two letters representing the card holder nationality. (e.g. “US”).
fullName	FullName	Full name of the card holder.
dateOfBirth	RFC3339 Date string	Date of birth of the card holder (e.g. `"2001-08-15"`).
address	Address	Address of the card holder.
phone	Phone	Phone of the card holder.
email	string	Email address of the card holder.
status	string	Status of the card, one of: `Active`, `Inactive`, `Stolen`, `Lost`, `Frozen`, `ClosedByCustomer`, `SuspectedFraud`.
design	string	Optional. Card design, if specified.

Relationships

Field	type	Description
account	JSON:API Relationship	Account the card belong to.
customer	JSON:API Relationship	Holder of the account.

IndividualVirtualDebitCard

Example IndividualVirtualDebitCard resource:

{
  "type": "individualVirtualDebitCard",
  "id": "8",
  "attributes": {
    "createdAt": "2020-05-13T09:07:47.645Z",
    "last4Digits": "1234",
    "expirationDate": "2022-05",
    "status": "Active"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "depositAccount",
        "id": "2"
      }
    },
    "customer": {
      "data": {
        "type": "individualCustomer",
        "id": "2"
      }
    }
  }
}

IndividualVirtualDebitCard is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the card resource.
type	string	Type of the card resource. For individual virtual debit card the value is always `individualVirtualDebitCard`.
attributes	JSON Object	JSON object representing the card data.
relationships	JSON:API Relationships	Describes relationships between the card resource and other resources (account and customer).

Attributes

Field	type	Description
createdAt	RFC3339 Date string	The date the resource was created.
last4Digits	string	Last 4 digits of the debit card.
expirationDate	string	Card expiration date, formatted `YYYY-MM`, e.g `"2020-05"`.
status	string	Status of the card, one of: `Active`, `Inactive`, `Stolen`, `Lost`, `Frozen`, `ClosedByCustomer`, `SuspectedFraud`.

Relationships

Field	type	Description
account	JSON:API Relationship	The account the card belongs to.
customer	JSON:API Relationship	The individual or business customer the card belongs to.

BusinessVirtualDebitCard

Example BusinessVirtualDebitCard resource:

{
  "type": "businessVirtualDebitCard",
  "id": "9",
  "attributes": {
    "createdAt": "2020-05-13T09:42:21.857Z",
    "last4Digits": "2074",
    "expirationDate": "2022-05",
    "address": {
      "street": "5230 Newell Rd",
      "street2": null,
      "city": "Palo Alto",
      "state": "CA",
      "postalCode": "94303",
      "country": "US"
    },
    "fullName": {
      "first": "Richard",
      "last": "Hendricks"
    },
    "phone": {
      "countryCode": "1",
      "number": "1555555578"
    },
    "email": "richard@piedpiper.com",
    "dateOfBirth": "2001-08-10",
    "ssn": "123456789",
    "status": "Active"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "depositAccount",
        "id": "1"
      }
    },
    "customer": {
      "data": {
        "type": "businessCustomer",
        "id": "1"
      }
    }
  }
}

BusinessVirtualDebitCard is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the card resource.
type	string	Type of the card resource. For business virtual debit card the value is always `businessVirtualDebitCard`.
attributes	JSON Object	JSON object representing the card data.
relationships	JSON:API Relationships	Describes relationships between the card resource and other resources (account and customer).

Attributes

Field	type	Description
createdAt	RFC3339 Date string	The date the resource was created.
last4Digits	string	Last 4 digits of the debit card.
expirationDate	string	Card expiration date, formatted `YYYY-MM`, e.g `"2020-05"`.
ssn	string	SSN of the card holder (numbers only). Either an SSN or a passport number is required.
passport	string	Passport number of the card holder. Either an SSN or a passport is required.
nationality	ISO31661-Alpha2 string	Only when Passport is populated. Two letters representing the card holder nationality. (e.g. “US”).
fullName	FullName	Full name of the card holder.
dateOfBirth	RFC3339 Date string	Date of birth of the card holder (e.g. `"2001-08-15"`).
address	Address	Address of the card holder.
phone	Phone	Phone of the card holder.
email	string	Email address of the card holder.
status	string	Status of the card, one of: `Active`, `Inactive`, `Stolen`, `Lost`, `Frozen`, `ClosedByCustomer`, `SuspectedFraud`.

Relationships

Field	type	Description
account	JSON:API Relationship	Account the card belong to.
customer	JSON:API Relationship	Holder of the account.

ACH Counterparty

Example Payment resource:

{
  "type": "achCounterparty",
  "id": "8",
  "attributes": {
    "createdAt": "2020-05-13T09:07:47.645Z",
    "name": "Joe Doe",
    "routingNumber": "011000138",
    "bank": "Bank Of America",
    "accountNumber": "123",
    "accountType": "Checking",
    "type": "Person",
    "permissions": "CreditOnly"
  },
  "relationships": {
    "customer": {
      "data": {
        "type": "customer",
        "id": "111111"
      }
    }
  }
}

Counterparty is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the ACH counterparty resource.
type	string	Type of the ACH counterparty resource.
attributes	JSON Object	JSON object representing the payment resource.
relationships	JSON:API Relationships	Describes relationships between the ACH counterparty and the originating customer.

Attributes

Name	Type	Description
createdAt	RFC3339 Date string	The date the resource was created.
name	string	The account holder's name (whether an individual or a business).
routingNumber	string	Valid 9-digit ABA routing transit number.
bank	string	Name of the bank.
accountNumber	string	Bank account number.
accountType	string	Either `Checking` or `Savings`.
type	string	Either `Business`, `Person` or `Unknown`.
permissions	string	Either `CreditOnly` or `CreditAndDebit`.

Relationships

Name	Type	Description
customer	JSON:API Relationship	The customer the counterparty belongs to.

ACH Payment

Example AchPayment resource:

{
  "data": {
    "type": "achPayment",
    "id": "50",
    "attributes": {
      "createdAt": "2020-01-13T16:01:19.346Z",
      "status": "Pending",
      "counterparty": {
        "routingNumber": "812345678",
        "accountNumber": "12345569",
        "accountType": "Checking",
        "name": "Jane Doe"
      },
      "description": "Funding",
      "direction": "Credit",
      "amount": 10000
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "555"
        }
      },
      "customer": {
        "data": {
          "type": "individualCustomer",
          "id": "99823"
        }
      },
      "counterparty": {
        "data": {
          "type": "counterparty",
          "id": "4567"
        }
      },
      "transaction": {
        "data": {
          "type": "transaction",
          "id" : "4003"
        }
      }
    }
  }
}

AchPayment is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the ACH payment resource.
type	string	Type of the payment resource. For originations the value is `achPayment`.
attributes	JSON Object	JSON object representing the payment resource.
relationships	JSON:API Relationships	Describes relationships between the ACH payment and the originating deposit account and customer.

Attributes

Name	Type	Description
createdAt	RFC3339 Date string	The date the resource was created.
status	string	One of `Pending`, `Rejected`, `Clearing`, `Sent`, `Canceled`, `Returned`. See ACH Status.
reason	string	(Optional) More information about the status.
counterparty	Counterparty	The party on the other side of the ACH payment.
direction	string	The direction in which the funds flow (either `Debit` or `Credit`).
description	string	Payment description (maximum of 10 characters), also known as Company Entry Description, this will show up on statement of the counterparty.
addenda	string	Optional, additional payment description (maximum of 50 characters), not all institutions present that.
amount	string	The amount (cents) of the payment.
settlementDate	RFC3339 Date string	Optional, For `Clearing`, shows the date on which the payment will be settled.
tags	object	See Tags.

Relationships

Name	Type	Description
account	JSON:API Relationship	The Deposit Account originating the transfer.
customer	JSON:API Relationship	The Customer the deposit account belongs to. The customer is either a business or a individual.
counterparty	JSON:API Relationship	The Counterparty the payment to be made to.

Book Payment

Example BookPayment resource:

{
  "data": {
    "type": "bookPayment",
    "id": "1232",
    "attributes": {
      "createdAt": "2021-02-21T13:03:19.025Z",
      "amount": 1500,
      "direction": "Credit",
      "description": "Funding",
      "status": "Sent"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "account",
          "id": "555"
        }
      },
      "customer": {
        "data": {
          "type": "customer",
          "id": "10000"
        }
      },
      "counterpartyAccount": {
        "data": {
          "type": "account",
          "id": "99821"
        }
      },
      "counterpartyCustomer": {
        "data": {
          "type": "customer",
          "id": "10000"
        }
      },
      "transaction": {
        "data": {
          "type": "transaction",
          "id": "1413"
        }
      }
    }
  }
}

BookPayment is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the book payment resource.
type	string	Type of the payment resource. The value is always `bookPayment`.
attributes	JSON Object	JSON object representing the payment resource.
relationships	JSON:API Relationships	Describes relationships between the ACH payment and the originating deposit account and customer.

Attributes

Name	Type	Description
createdAt	RFC3339 Date string	The date the resource was created.
status	string	Either `Sent` or `Rejected` (see `reason` for details).
reason	string	(Optional) More information about the status.
direction	string	The direction in which the funds flow (either `Debit` or `Credit`).
description	string	Payment description (maximum of 50 characters), this will show up on statement of the counterparty.
amount	string	The amount (cents) of the payment.
tags	object	See Tags.

Relationships

Name	Type	Description
account	JSON:API Relationship	The Deposit Account creating the payment.
customer	JSON:API Relationship	The Customer the deposit account belongs to. The customer is either a business or a individual.
counterpartyAccount	JSON:API Relationship	The Counterparty account the payment to be made to.
counterpartyCustomer	JSON:API Relationship	The Customer the counterparty account belongs to. The customer is either a business or a individual.
transaction	JSON:API Relationship	The Book Transaction generated by this payment.

Originated ACH Transaction

Example OriginatedAchTransaction resource:

{
  "type": "originatedAchTransaction",
  "id": "1",
  "attributes": {
    "createdAt": "2020-09-06T07:51:02.570Z",
    "direction": "Credit",
    "amount": 10000,
    "balance": 10000,
    "summary": "Counterparty: Unit Inc | Description: Funding",
    "description": "Funding",
    "counterparty": {
      "name": "Unit Inc",
      "routingNumber": "812345678",
      "accountNumber": "1",
      "accountType": "Checking"
    }
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "10001"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "3"
      }
    },
    "payment": {
      "data": {
        "type": "payment",
        "id": "5"
      }
    }
  }
}

OriginatedAchTransaction is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the transaction resource.
type	string	Type of the transaction resource. The value is always `originatedAchTransaction`.
attributes	JSON Object	JSON object representing the transaction data.
relationships	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account and customer).

Attributes

Field	type	Description
createdAt	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction	string	The direction in which the funds flow. Common to all transaction types.
amount	integer	The amount (cents) of the transaction. Common to all transaction types.
balance	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary	string	Summary of the transaction. Common to all transaction types.
description	string	Transaction description.
counterparty	Counterparty	The party on the other end of the transaction.
tags	object	See Tags. Inherited from the payment tags (see Tag Inheritance).

Relationships

Field	type	Description
account	JSON:API Relationship	The Deposit Account of the customer.
customer	JSON:API Relationship	The customer the deposit account belongs to. The customer is either a business or a individual.
payment	JSON:API Relationship	The payment belonging to this transaction.

Received ACH Transaction

Example ReceivedAchTransaction resource:

{
  "type": "receivedAchTransaction",
  "id": "4",
  "attributes": {
    "createdAt": "2020-09-08T12:41:43.360Z",
    "direction": "Debit",
    "amount": 80000,
    "balance": 90000,
    "summary": "Company: Unit Inc | Description: Payment from Unit Inc.",
    "description": "Payment from Unit Inc.",
    "companyName": "Unit Inc",
    "counterpartyRoutingNumber": "812345678",
    "traceNumber": "021214860002342",
    "secCode": "WEB"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "1"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "3"
      }
    }
  }
}

ReceivedAchTransaction is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the transaction resource.
type	string	Type of the transaction resource. The value is always `receivedAchTransaction`.
attributes	JSON Object	JSON object representing the transaction data.
relationships	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account and customer).

Attributes

Field	type	Description
createdAt	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction	string	The direction in which the funds flow. Common to all transaction types.
amount	integer	The amount (cents) of the transaction. Common to all transaction types.
balance	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary	string	Summary of the transaction. Common to all transaction types.
description	string	Transaction description.
addenda	string	Optional. Additional transaction description (maximum of 50 characters).
companyName	string	The name by which the originator is known to the receiver.
counterpartyRoutingNumber	string	The routing number of the party that originated the ACH payment.
traceNumber	string	The ACH Trace Number.
secCode	string	Optional. The 3-letter ACH Standard Entry Class (SEC) Code (e.g. `WEB`, `CCD`, `PPD`, etc.).
tags	object	See Tags.

Relationships

Field	type	Description
account	JSON:API Relationship	The Deposit Account of the customer.
customer	JSON:API Relationship	The customer the deposit account belongs to. The customer is either a business or a individual.

Returned ACH Transaction

Example ReturnedAchTransaction resource:

{
  "type": "returnedAchTransaction",
  "id": "4",
  "attributes": {
    "createdAt": "2020-09-08T12:41:43.360Z",
    "direction": "Debit",
    "amount": 1000,
    "balance": 9000,
    "summary": "Return due to: NoAccount | Counterparty: Unit Inc",
    "companyName": "Unit Inc",
    "counterpartyName": "Unit Inc",
    "counterpartyRoutingNumber": "812345678",
    "reason": "NoAccount"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "1"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "3"
      }
    },
    "payment": {
      "data": {
        "type": "payment",
        "id": "1"
      }
    }
  }
}

ReturnedAchTransaction is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the transaction resource.
type	string	Type of the transaction resource. The value is always `returnedAchTransaction`.
attributes	JSON Object	JSON object representing the transaction data.
relationships	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account and customer).

Attributes

Field	type	Description
createdAt	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction	string	The direction in which the funds flow. Common to all transaction types.
amount	integer	The amount (cents) of the transaction. Common to all transaction types.
balance	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary	string	Summary of the transaction. Common to all transaction types.
companyName	string	The name by which the originator is known to the receiver.
counterpartyName	string	The name of the party that originated the ACH payment.
counterpartyRoutingNumber	string	The routing number of the party that originated the ACH payment.
reason	string	The reason for the transaction return.
tags	object	See Tags.

Relationships

Field	type	Description
account	JSON:API Relationship	The Deposit Account of the customer.
customer	JSON:API Relationship	The customer the deposit account belongs to. The customer is either a business or a individual.
payment	JSON:API Relationship	The returned payment.

Returned Received ACH Transaction

Example ReturnedReceivedAchTransaction resource:

{
  "type": "returnedReceivedAchTransaction",
  "id": "4",
  "attributes": {
    "createdAt": "2020-09-08T12:41:43.360Z",
    "direction": "Debit",
    "amount": 1000,
    "balance": 500,
    "summary": "Returned received ACH transaction #55 due to: InsufficientFunds",
    "companyName": "John Doe",    
    "reason": "InsufficientFunds"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "1"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "3"
      }
    },
    "returned": {
      "data": {
        "type": "transaction",
        "id": "55"
      }
    }
  }
}

The transaction is used to return a received ACH, automatically by Unit (e.g insufficient funds), by a dispute, or manually via Return Received ACH.

ReturnedReceivedAchTransaction is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the transaction resource.
type	string	Type of the transaction resource. The value is always `returnedAchTransaction`.
attributes	JSON Object	JSON object representing the transaction data.
relationships	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account and customer).

Attributes

Field	type	Description
createdAt	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction	string	The direction in which the funds flow. Common to all transaction types.
amount	integer	The amount (cents) of the transaction. Common to all transaction types.
balance	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary	string	Summary of the transaction. Common to all transaction types.
companyName	string	The name by which the originator is known to the receiver.
reason	string	The reason for the transaction return.
tags	object	See Tags.

Relationships

Field	type	Description
account	JSON:API Relationship	The Deposit Account of the customer.
customer	JSON:API Relationship	The customer the deposit account belongs to. The customer is either a business or a individual.
returned	JSON:API Relationship	The returned transaction.

Dishonored ACH Transaction

Example DishonoredAchTransaction resource:

{
  "type": "dishonoredAchTransaction",
  "id": "423",
  "attributes": {
    "createdAt": "2021-03-11T12:24:51.360Z",
    "direction": "Debit",
    "amount": 61000,
    "balance": 0,
    "summary": "Company: Unit Inc | Description: Payment from Unit Inc.",
    "description": "Payment from Unit Inc.",
    "companyName": "Unit Inc",
    "counterpartyRoutingNumber": "812345678",
    "traceNumber": "021214860002342",
    "secCode": "WEB"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "1"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "3"
      }
    }
  }
}

DishonoredAchTransaction is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the transaction resource.
type	string	Type of the transaction resource. The value is always `receivedAchTransaction`.
attributes	JSON Object	JSON object representing the transaction data.
relationships	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account and customer).

Attributes

Field	type	Description
createdAt	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction	string	The direction in which the funds flow. Common to all transaction types.
amount	integer	The amount (cents) of the transaction. Common to all transaction types.
balance	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary	string	Summary of the transaction. Common to all transaction types.
description	string	Transaction description.
companyName	string	The name by which the originator is known to the receiver.
counterpartyRoutingNumber	string	The routing number of the party that originated the ACH payment.
traceNumber	string	The ACH Trace Number.
reason	string	The reason for the dishonored return.
secCode	string	Optional. The 3-letter ACH Standard Entry Class (SEC) Code (e.g. `WEB`, `CCD`, `PPD`, etc.).
tags	object	See Tags.

Relationships

Field	type	Description
account	JSON:API Relationship	The Deposit Account of the customer.
customer	JSON:API Relationship	The customer the deposit account belongs to. The customer is either a business or a individual.

Book Transaction

Example BookTransaction resource:

{
  "type": "bookTransaction",
  "id": "9547",
  "attributes": {
    "createdAt": "2020-07-05T15:49:36.864Z",
    "direction": "Credit",
    "amount": 1000,
    "balance": 12000,
    "summary": "Counterparty: Jane Smith | Description: Gift",
    "counterparty": {
      "name": "Jane Smith",
      "routingNumber": "812345678",
      "accountNumber": "10039",
      "accountType": "Checking"
    }
  },
  "relationships": {
    "account": {
      "data": {
        "type": "depositAccount",
        "id": "10035"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "5"
      }
    },
    "counterpartyAccount": {
      "data": {
        "type": "account",
        "id": "10036"
      }
    },
    "counterpartyCustomer": {
      "data": {
        "type": "customer",
        "id": "7"
      }
    }
  }
}

BookTransaction is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the transaction resource.
type	string	Type of the transaction resource. The value is always `bookTransaction`.
attributes	JSON Object	JSON object representing the transaction data.
relationships	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account and customer).
tags	object	See Tags. Inherited from the payment tags (see Tag Inheritance).

Attributes

Field	type	Description
createdAt	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction	string	The direction in which the funds flow. Common to all transaction types.
amount	integer	The amount (cents) of the transaction. Common to all transaction types.
balance	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary	string	Summary of the transaction. Common to all transaction types.
counterparty	Counterparty	The party on the other end of the transaction.

Relationships

Field	type	Description
account	JSON:API Relationship	The Deposit Account of the customer.
customer	JSON:API Relationship	The customer the deposit account belongs to. The customer is either a business or a individual.
counterpartyAccount	JSON:API Relationship	The account of the counterparty.
counterpartyCustomer	JSON:API Relationship	The counterparty customer.

Purchase Transaction

Example PurchaseTransaction resource:

{
  "type": "purchaseTransaction",
  "id": "51",
  "attributes": {
    "createdAt": "2020-09-08T12:41:43.360Z",
    "direction": "Debit",
    "amount": 2500,
    "balance": 10523,
    "summary": "Car rental",
    "cardLast4Digits": "2282",
    "merchant": {
      "name": "Europcar Mobility Group",
      "type": 3381,
      "category": "EUROP CAR",
      "location": "Cupertino, CA"
    },
    "coordinates": {
      "longitude": -77.0364,
      "latitude": 38.8951
    },
    "recurring": false
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "10001"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "3"
      }
    },
    "card": {
      "data": {
        "type": "card",
        "id": "11"
      }
    },
    "authorization": {
      "data": {
        "type": "authorization",
        "id": "40"
      }
    }
  }
}

PurchaseTransaction is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the transaction resource.
type	string	Type of the transaction resource. The value is always `purchaseTransaction`.
attributes	JSON Object	JSON object representing the transaction data.
relationships	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account and customer).

Attributes

Field	type	Description
createdAt	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction	string	The direction in which the funds flow. Common to all transaction types.
amount	integer	The amount (cents) of the transaction. Common to all transaction types.
balance	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary	string	Summary of the transaction. Common to all transaction types.
cardLast4Digits	string	The last 4 digits of the debit card involved in the transaction.
merchant.name	string	The name of the merchant.
merchant.type	integer	The 4-digit ISO 18245 merchant category code (MCC).
merchant.category	string	The merchant category, described by the MCC code (see this reference for the list of category descriptions).
merchant.location	string	Optional. The location (city, state, etc.) of the merchant.
coordinates	Coordinates	Optional. Coordinates (latitude, longitude) of where the purchase took place.
recurring	boolean	Indicates whether the transaction is recurring
tags	object	See Tags.

Relationships

Field	type	Description
account	JSON:API Relationship	The Deposit Account of the customer.
customer	JSON:API Relationship	The customer the deposit account belongs to. The customer is either a business or a individual.
card	JSON:API Relationship	The debit card involved in the transaction.
authorization	JSON:API Relationship	Optional. The Authorization request made by the merchant, if present (see Authorizations).

ATM Transaction

Example AtmTransaction resource:

{
  "type": "atmTransaction",
  "id": "1432",
  "attributes": {
    "createdAt": "2020-07-05T15:49:36.864Z",
    "direction": "Credit",
    "amount": 10000,
    "balance": 12000,
    "summary": "ATM deposit",
    "cardLast4Digits": "2282",
    "atmName": "First National Bank",
    "atmLocation": "Masontown, PA 15461",
    "surcharge": 10
  },
  "relationships": {
    "account": {
      "data": {
        "type": "depositAccount",
        "id": "1000"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "3"
      }
    },
    "card": {
      "data": {
        "type": "card",
        "id": "11"
      }
    }
  }
}

AtmTransaction is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the transaction resource.
type	string	Type of the transaction resource. The value is always `atmTransaction`.
attributes	JSON Object	JSON object representing the transaction data.
relationships	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account and customer).

Attributes

Field	type	Description
createdAt	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction	string	The direction in which the funds flow. Common to all transaction types.
amount	integer	The amount (cents) of the transaction, including the surcharge fee. Common to all transaction types.
balance	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary	string	Summary of the transaction. Common to all transaction types.
cardLast4Digits	string	The last 4 digits of the debit card involved in the transaction.
atmName	string	The name of the ATM.
atmLocation	string	Optional. The location (city, state, etc.) of the ATM.
surcharge	number	The surcharge fee (cents) for the transaction.
tags	object	See Tags.

Relationships

Field	type	Description
account	JSON:API Relationship	The Deposit Account of the customer.
customer	JSON:API Relationship	The customer the deposit account belongs to. The customer is either a business or a individual.
card	JSON:API Relationship	The debit card involved in the transaction.

Fee Transaction

Example FeeTransaction resource:

{
  "type": "feeTransaction",
  "id": "388",
  "attributes": {
    "createdAt": "2020-09-08T12:41:43.360Z",
    "direction": "Debit",
    "amount": 10,
    "balance": 89980,
    "summary": "Payment fee for transaction #4"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "10001"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "3"
      }
    },
    "relatedTransaction": {
      "data": {
        "type": "transaction",
        "id": "4"
      }
    }
  }
}

FeeTransaction is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the transaction resource.
type	string	Type of the transaction resource. The value is always `feeTransaction`.
attributes	JSON Object	JSON object representing the transaction data.
relationships	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account, customer and relatedTransaction).

Attributes

Field	type	Description
createdAt	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction	string	The direction in which the funds flow. Common to all transaction types.
amount	integer	The amount (cents) of the transaction. Common to all transaction types.
balance	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary	string	Summary of the transaction. Common to all transaction types.
tags	object	See Tags.

Relationships

Field	type	Description
account	JSON:API Relationship	The Deposit Account of the customer.
customer	JSON:API Relationship	The customer the deposit account belongs to. The customer is either a business or a individual.
relatedTransaction	JSON:API Relationship	Optional. The transaction which the fee is subject to.

Card Reversal Transaction

Example CardReversalTransaction resource:

{
  "type": "cardReversalTransaction",
  "id": "401",
  "attributes": {
    "createdAt": "2020-09-14T12:41:43.360Z",
    "direction": "Debit",
    "amount": 10,
    "balance": 89980,
    "summary": "Reversal for transaction #400",
    "cardLast4Digits": "2282"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "10001"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "1001"
      }
    },
    "relatedTransaction": {
      "data": {
        "type": "transaction",
        "id": "400"
      }
    }
  }
}

CardReversalTransaction is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the transaction resource.
type	string	Type of the transaction resource. The value is always `cardReversalTransaction`.
attributes	JSON Object	JSON object representing the transaction data.
relationships	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account, customer and relatedTransaction).

Attributes

Field	type	Description
createdAt	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction	string	The direction in which the funds flow. Common to all transaction types.
amount	integer	The amount (cents) of the transaction. Common to all transaction types.
balance	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary	string	Summary of the transaction. Common to all transaction types.
cardLast4Digits	string	The last 4 digits of the debit card involved in the transaction.
tags	object	See Tags.

Relationships

Field	type	Description
account	JSON:API Relationship	The Deposit Account of the customer.
customer	JSON:API Relationship	The customer the deposit account belongs to. The customer is either a business or a individual.
relatedTransaction	JSON:API Relationship	Optional. The transaction which the reversal is related to.

Card Transaction

Example CardTransaction resource:

{
  "type": "cardTransaction",
  "id": "410",
  "attributes": {
    "createdAt": "2020-09-20T12:41:43.360Z",
    "direction": "Debit",
    "amount": 10,
    "balance": 89480,
    "summary": "Card transaction details",
    "cardLast4Digits": "2282"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "10001"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "1001"
      }
    }
  }
}

CardTransaction is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the transaction resource.
type	string	Type of the transaction resource. The value is always `cardTransaction`.
attributes	JSON Object	JSON object representing the transaction data.
relationships	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account and customer).

Attributes

Field	type	Description
createdAt	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction	string	The direction in which the funds flow. Common to all transaction types.
amount	integer	The amount (cents) of the transaction. Common to all transaction types.
balance	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary	string	Summary of the transaction. Common to all transaction types.
cardLast4Digits	string	The last 4 digits of the debit card involved in the transaction.
tags	object	See Tags.

Relationships

Field	type	Description
account	JSON:API Relationship	The Deposit Account of the customer.
customer	JSON:API Relationship	The customer the deposit account belongs to. The customer is either a business or a individual.

Wire Transaction

Example WireTransaction resource:

{
  "type": "wireTransaction",
  "id": "9547",
  "attributes": {
    "createdAt": "2020-07-05T15:49:36.864Z",
    "direction": "Credit",
    "amount": 1000,
    "balance": 12000,
    "summary": "Wire from Jane Smith",
    "counterparty": {
      "name": "Jane Smith",
      "routingNumber": "812345678",
      "accountNumber": "10039",
      "accountType": "Checking"
    }
  },
  "relationships": {
    "account": {
      "data": {
        "type": "depositAccount",
        "id": "10035"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "5"
      }
    }
  }
}

WireTransaction is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the transaction resource.
type	string	Type of the transaction resource. The value is always `wireTransaction`.
attributes	JSON Object	JSON object representing the transaction data.
relationships	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account and customer).

Attributes

Field	type	Description
createdAt	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction	string	The direction in which the funds flow. Common to all transaction types.
amount	integer	The amount (cents) of the transaction. Common to all transaction types.
balance	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary	string	Summary of the transaction. Common to all transaction types.
counterparty	Counterparty	The party on the other end of the transaction, either the beneficiary or the originator.
description	string	Description of the transaction as entered by the originator. Also known as OBI or “Originator to Beneficiary Information”.
senderReference	string	Sender reference.
referenceForBeneficiary	string	Reference for the Beneficiary.
tags	object	See Tags.

Relationships

Field	type	Description
account	JSON:API Relationship	The Deposit Account of the customer.
customer	JSON:API Relationship	The customer the deposit account belongs to. The customer is either a business or a individual.

Release Transaction

Example ReleaseTransaction resource:

{
  "type": "releaseTransaction",
  "id": "258",
  "attributes": {
    "createdAt": "2020-12-08T15:38:07.394Z",
    "senderName": "Richard Hendricks",
    "senderAddress": {
      "street": "5230 Newell Rd",
      "city": "Palo Alto",
      "state": "CA",
      "postalCode": "94303",
      "country": "US"
    },
    "senderAccountNumber": "123456798",
    "counterparty": {
      "name": "BatchAccount15",
      "routingNumber": "812345678",
      "accountNumber": "1000000096",
      "accountType": "Checking"
    },
    "amount": 1000,
    "direction": "Credit",
    "description": "First Payment",
    "balance": 1000,
    "summary": "First Payment  |  Richard Hendricks"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "10097"
      }
    }
  }
}

ReleaseTransaction is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the transaction resource.
type	string	Type of the transaction resource. The value is always `releaseTransaction`.
attributes	JSON Object	JSON object representing the transaction data.
relationships	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account).

Attributes

Field	type	Description
createdAt	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
senderName	string	Name of the sender.
senderAddress	Address	Address of the sender.
senderAccountNumber	string	Unique identifier to monitor for similar sending accounts, could be the BIN + last four digits of the card number OR a unique identifier generated by you for the sender.
counterparty	Counterparty	The party who is releasing the funds
amount	integer	The amount (cents) of the transaction. Common to all transaction types.
direction	string	The direction in which the funds flow. Common to all transaction types. The value is always `Credit`.
description	string	Description of the payment.
balance	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary	string	Summary of the transaction. Common to all transaction types.
tags	object	See Tags.

Relationships

Field	type	Description
account	JSON:API Relationship	The Deposit Account receiving the funds.

Adjustment Transaction

Example AdjustmentTransaction resource:

{
  "type": "adjustmentTransaction",
  "id": "215",
  "attributes": {
    "createdAt": "2021-04-12T16:08:39.040Z",
    "amount": 5000,
    "direction": "Debit",
    "balance": 3124000,
    "summary": "correction of transaction #200",
    "description": "correction of transaction #200"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "10001"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "10000"
      }
    }
  }
}

AdjustmentTransaction is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the transaction resource.
type	string	Type of the transaction resource. The value is always `adjustmentTransaction`.
attributes	JSON Object	JSON object representing the transaction data.
relationships	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account).

Attributes

Field	type	Description
createdAt	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction	string	The direction in which the funds flow. Common to all transaction types.
amount	integer	The amount (cents) of the transaction. Common to all transaction types.
balance	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary	string	Summary of the transaction. Common to all transaction types.
description	string	Description of the transaction.
tags	object	See Tags.

Relationships

Field	type	Description
account	JSON:API Relationship	The Deposit Account participating in the transaction.

Interest Transaction

Example InterestTransaction resource:

{
  "type": "interestTransaction",
  "id": "9547",
  "attributes": {
    "createdAt": "2020-07-05T15:49:36.864Z",
    "direction": "Credit",
    "amount": 1000,
    "balance": 12000,
    "summary": "Interest March 2020"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "depositAccount",
        "id": "10035"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "5"
      }
    }
  }
}

InterestTransaction is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the transaction resource.
type	string	Type of the transaction resource. The value is always `interestTransaction`.
attributes	JSON Object	JSON object representing the transaction data.
relationships	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account and customer).

Attributes

Field	type	Description
createdAt	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction	string	The direction in which the funds flow. Common to all transaction types.
amount	integer	The amount (cents) of the transaction. Common to all transaction types.
balance	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary	string	Summary of the transaction. Common to all transaction types.
tags	object	See Tags.

Relationships

Field	type	Description
account	JSON:API Relationship	The Deposit Account of the customer.
customer	JSON:API Relationship	The customer the deposit account belongs to. The customer is either a business or a individual.

Dispute Transaction

Example DisputeTransaction resource:

{
  "type": "disputeTransaction",
  "id": "226",
  "attributes": {
    "createdAt": "2021-04-19T12:44:08.055Z",
    "amount": 2500,
    "direction": "Credit",
    "balance": 550000,
    "summary": "Dispute 119 | Provisional Credit",
    "reason": "ProvisionalCredit"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "10001"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "10000"
      }
    }
  }
}

DisputeTransaction is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the transaction resource.
type	string	Type of the transaction resource. The value is always `disputeTransaction`.
attributes	JSON Object	JSON object representing the transaction data.
relationships	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account, customer).

Attributes

Field	type	Description
createdAt	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction	string	The direction in which the funds flow. Common to all transaction types.
amount	integer	The amount (cents) of the transaction. Common to all transaction types.
balance	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary	string	Summary of the transaction. Common to all transaction types.
reason	string	The reason for the dispute transaction, one of: `ProvisionalCredit`, `ProvisionalCreditReversalDenied`, `ProvisionalCreditReversalResolved`, `FinalCredit`.
tags	object	See Tags.

Relationships

Field	type	Description
account	JSON:API Relationship	The Deposit Account participating in the transaction.
customer	JSON:API Relationship	The customer the deposit account belongs to. The customer is either a business or a individual.

Check Deposit Transaction

Example CheckDepositTransaction resource:

{
  "data": {
    "type": "checkDepositTransaction",
    "id": "264",
    "attributes": {
      "createdAt": "2021-06-06T07:21:51.467Z",
      "amount": 200,
      "direction": "Credit",
      "balance": 371600,
      "summary": "Check deposit"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "account",
          "id": "10001"
        }
      },
      "customer": {
        "data": {
          "type": "customer",
          "id": "10000"
        }
      },
      "checkDeposit": {
        "data": {
          "type": "checkDeposit",
          "id": "122"
        }
      }
    }
  }
}

CheckDepositTransaction is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the transaction resource.
type	string	Type of the transaction resource. The value is always `checkDepositTransaction`.
attributes	JSON Object	JSON object representing the transaction data.
relationships	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account, customer, checkDeposit).

Attributes

Field	type	Description
createdAt	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction	string	The direction in which the funds flow. Common to all transaction types.
amount	integer	The amount (cents) of the transaction. Common to all transaction types.
balance	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary	string	Summary of the transaction. Common to all transaction types.
tags	object	See Tags.

Relationships

Field	type	Description
account	JSON:API Relationship	The Deposit Account participating in the transaction.
customer	JSON:API Relationship	The customer the deposit account belongs to. The customer is either a business or a individual.
checkDeposit	JSON:API Relationship	The Check Deposit the transaction is related to.

Returned Check Deposit Transaction

Example ReturnedCheckDepositTransaction resource:

{
  "data": {
    "type": "returnedCheckDepositTransaction",
    "id": "265",
    "attributes": {
      "createdAt": "2021-06-06T07:23:30.101Z",
      "amount": 200,
      "direction": "Debit",
      "balance": 3716500,
      "summary": "Returned due to: Insufficient Funds  |  Check deposit",
      "reason": "Insufficient Funds"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "account",
          "id": "10001"
        }
      },
      "customer": {
        "data": {
          "type": "customer",
          "id": "10000"
        }
      },
      "checkDeposit": {
        "data": {
          "type": "checkDeposit",
          "id": "122"
        }
      }
    }
  }
}

ReturnedCheckDepositTransaction is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the transaction resource.
type	string	Type of the transaction resource. The value is always `returnedCheckDepositTransaction`.
attributes	JSON Object	JSON object representing the transaction data.
relationships	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account, customer, checkDeposit).

Attributes

Field	type	Description
createdAt	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction	string	The direction in which the funds flow. Common to all transaction types.
amount	integer	The amount (cents) of the transaction. Common to all transaction types.
balance	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary	string	Summary of the transaction. Common to all transaction types.
reason	string	The reason for the transaction return.
tags	object	See Tags.

Relationships

Field	type	Description
account	JSON:API Relationship	The Deposit Account participating in the transaction.
customer	JSON:API Relationship	The customer the deposit account belongs to. The customer is either a business or a individual.
checkDeposit	JSON:API Relationship	The Check Deposit the transaction is related to.

Authorization

Example Authorization resource:

{
  "type": "authorization",
  "id": "97",
  "attributes": {
    "createdAt": "2021-02-21T07:29:42.447Z",
    "amount": 2000,
    "cardLast4Digits": "0019",
    "merchant": {
      "name": "Europcar Mobility Group",
      "type": 3381,
      "category": "EUROP CAR",
      "location": "Cupertino, CA"
    },
    "recurring": false
  },
  "relationships": {
    "customer": {
      "data": {
        "type": "customer",
        "id": "10000"
      }
    },
    "account": {
      "data": {
        "type": "account",
        "id": "10001"
      }
    }
  }
}

Authorization is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the authorization resource.
type	string	Type of the authorization resource. The value is always `authorization`.
attributes	JSON Object	JSON object representing the authorization data.
relationships	JSON:API Relationships	Describes relationships between the authorization resource and other resources (account and customer).

Attributes

Field	type	Description
createdAt	RFC3339 Date string	The date the authorization was created.
amount	integer	The amount (cents) of the authorization.
cardLast4Digits	string	The last 4 digits of the debit card involved in the authorization.
merchant.name	string	The name of the merchant.
merchant.type	integer	The 4-digit ISO 18245 merchant category code (MCC).
merchant.category	string	The merchant category, described by the MCC code (see this reference for the list of category descriptions).
merchant.location	string	Optional. The location (city, state, etc.) of the merchant.
recurring	boolean	Indicates whether the authorization is recurring

Relationships

Field	type	Description
account	JSON:API Relationship	The Deposit Account of the customer.
customer	JSON:API Relationship	The customer the deposit account belongs to. The customer is either a business or a individual.

Purchase Authorization Request

Example PurchaseAuthorizationRequest resource:

{
  "type": "purchaseAuthorizationRequest",
  "id": "1",
  "attributes": {
    "createdAt": "2021-06-22T13:39:17.018Z",
    "amount": 2500,
    "status": "Pending",
    "partialApprovalAllowed": false,
    "merchant": {
      "name": "Apple Inc.",
      "type": 1000,
      "category": "",
      "location": "Cupertino, CA"
    },
    "recurring": false
  },
  "relationships": {
    "customer": {
      "data": {
        "type": "customer",
        "id": "10000"
      }
    },
    "account": {
      "data": {
        "type": "account",
        "id": "10001"
      }
    },
    "card": {
      "data": {
        "type": "card",
        "id": "7"
      }
    }
  }
}

PurchaseAuthorizationRequest is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the purchase authorization request resource.
type	string	Type of the purchase authorization request resource. The value is always `purchaseAuthorizationRequest`.
attributes	JSON Object	JSON object representing the authorization request data.
relationships	JSON:API Relationships	Describes relationships between the authorization request resource and other resources (account, customer and card).

Attributes

Field	type	Description
createdAt	RFC3339 Date string	The date the authorization request was created.
amount	integer	The amount (cents) of the authorization request.
status	string	The status of the authorization request. Either `Pending`, `Approved` or `Declined`.
partialApprovalAllowed	boolean	Indicates whether the authorization request supports partial amount approval.
approvedAmount	integer	Optional. The amount (cents) that was approved. Available only when status is `Approved`.
declineReason	string	Optional. The reason the authorization request was declined. One of `AccountClosed`, `CardExceedsAmountLimit`, `DoNotHonor`, `InsufficientFunds`, `InvalidMerchant`, `ReferToCardIssuer`, `RestrictedCard`, `Timeout`, `TransactionNotPermittedToCardholder`. Available only when status is `Declined`
merchant.name	string	The name of the merchant.
merchant.type	integer	The 4-digit ISO 18245 merchant category code (MCC).
merchant.category	string	The merchant category, described by the MCC code (see this reference for the list of category descriptions).
merchant.location	string	Optional. The location (city, state, etc.) of the merchant.
recurring	boolean	Indicates whether the authorization is recurring

Relationships

Field	type	Description
account	JSON:API Relationship	The Deposit Account of the customer.
customer	JSON:API Relationship	The customer the deposit account belongs to. The customer is either a business or a individual.
card	JSON:API Relationship	The debit card used in the purchase.

Statement

Example Statement resource:

  {
    "type": "statement",
    "id": "1",
    "attributes": {
      "period": "2020-07"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "account",
          "id": "1000"
        }
      },
      "customer": {
        "data": {
          "type": "customer",
          "id": "1"
        }
      }
    }
  }

Statement is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the statement resource.
type	string	Type of the statement resource. The value is always `statement`.
attributes	JSON Object	JSON object representing the statement data.
relationships	JSON:API Relationships	Describes relationships between the statement resource and other resources (account and customer).

Attributes

Field	type	Description
period	string	Period of the statement, formatted `YYYY-MM`, e.g `"2020-05"`.

Relationships

Field	type	Description
account	JSON:API Relationship	The account for which the statement was produced.
customer	JSON:API Relationship	The individual or business customer the account belongs to.

BatchRelease

Example BatchRelease resource:

{
  "type": "batchRelease",
  "id": "100123",
  "attributes": {
    "amount": 3000,
    "description": "Gift",
    "senderName": "Sherlock Holmes",
    "senderAccountNumber": "4581133972",
    "senderAddress": {
      "street": "221B Baker Street",
      "city": "London",
      "postalCode": "NW1 6XE",
      "country": "UK"
    }
  },
  "relationships": {
    "batchAccount": {
      "data": {
        "type": "batchAccount",
        "id": "10104"
      }
    },
    "receiver": {
      "data": {
        "type": "depositAccount",
        "id": "10097"
      }
    }
  }
}

BatchRelease is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the batch-release resource.
type	string	Type of the batch-release resource. The value is always `batchRelease`.
attributes	JSON Object	JSON object representing the batch-release data.
relationships	JSON:API Relationships	Describes relationships between the batch-release resource and other resources (accounts).

Attributes

Name	Type	Description
amount	integer	The amount (in cents) to move from the batch account to the receiver account.
description	string	Description of the payment.
senderName	string	Name of the sender, before combining the payments.
senderAddress	Address	Address of the sender.
senderAccountNumber	string	Unique identifier to monitor for similar sending accounts, could be the BIN + last four digits of the card number OR a unique identifier generated by you for the sender.

Relationships

Name	Type	Description
batchAccount	JSON:API Relationship	The batch account to release the funds from.
receiver	JSON:API Relationship	The account to release the funds to.

Fee

Example Fee resource:

{
  "data": {
    "type": "fee",
    "id": "1234",
    "attributes": {
      "amount": 1000,
      "description": "Monthly Subscription"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "10097"
        }
      }
    }
  }
}

Fee is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the fee resource.
type	string	Type of the fee resource. The value is always `fee`.
attributes	JSON Object	JSON object representing the fee data.
relationships	JSON:API Relationships	Describes relationships between the fee resource and other resources (accounts).

Attributes

Name	Type	Description
amount	integer	The amount (in cents) of the fee.
description	string	Description of the fee.
tags	object	See Tags.

Relationships

Name	Type	Description
account	JSON:API Relationship	The account the fee belongs to.

Event

Example Event resource:

{
  "data": [
    {
      "id": "230",
      "type": "transaction.created",
      "attributes": {
        "createdAt": "2021-03-15T07:49:09.089Z",
        "amount": 10000,
        "direction": "Credit",
        "summary": "Wire from Sender"
      },
      "relationships": {
        "account": {
          "data": {
            "id": "10005",
            "type": "account"
          }
        },
        "transaction": {
          "data": {
            "id": "189",
            "type": "wireTransaction"
          }
        },
        "customer": {
          "data": {
            "id": "10000",
            "type": "individualCustomer"
          }
        }
      }
    }
  ]
}

Event is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the event resource.
type	string	Type of the event resource.
attributes	JSON Object	JSON object representing the event data, based on the event type. See Events.
relationships	JSON:API Relationships	Describes relationships between the event resource and other resources, based on the event type. See Events.

Webhook

Example Webhook resource:

{
  "data": {
    "type": "webhook",
    "id": "15",
    "attributes": {
      "createdAt": "2021-04-28T09:35:01.028Z",
      "label": "some label",
      "url": "https://webhook.site/81ee6b53-fde4-4b7d-85a0-0b6249a4488d",
      "status": "Enabled",
      "contentType": "Json",
      "token": "MyToken"
    }
  }
}

Webhook is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the webhook resource.
type	string	Type of the webhook resource. The value is always `webhook`.
attributes	JSON Object	JSON object representing the webhook data.

Attributes

Name	Type	Description
createdAt	RFC3339 Date string	The date the webhook was created.
label	string	A label describing the webhook.
url	string	The URL of the webhook endpoint.
status	string	The status of the webhook. Either `Enabled` or `Disabled`.
contentType	string	The type of content you wish to receive. Either `Json` or `JsonAPI`.
token	string	The secret token (see Securing your webhooks).

APIToken

Example APIToken resource:

{
  "data": {
    "id": "20",
    "type": "apiToken",
    "attributes": {
      "createdAt": "2021-07-01T09:04:50.987Z",
      "description": "Production token",
      "expiration": "2022-07-01T13:47:17.000Z",
      "token": "v2.public.eyJyb2xlIjoib3JnI..."
    }
  }
}

APIToken is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the api token resource.
type	string	Type of the api token resource. The value is always `apiToken`.
attributes	JSON Object	JSON object representing the api token data.

Attributes

Name	Type	Description
createdAt	RFC3339 Date string	The date the API token was created.
description	string	A description of the API token.
expiration	RFC3339 Date string	Expiration date of the API token.
token	string	Optional. The actual bearer token. Available only on API token creation response.
sourceIp	string	Optional. A comma separated list of IP addresses that are allowed to use the API token.

Account End-Of-Day

Example Account End-Of-Day resource:

{
  "type": "accountEndOfDay",
  "id": "4925158",
  "attributes": {
    "date": "2021-07-10",
    "balance": 1000,
    "available": 500,
    "hold": 500
  },
  "relationships": {
    "customer": {
      "data": {
        "type": "customer",
        "id": "10000"
      }
    },
    "account": {
      "data": {
        "type": "account",
        "id": "30317"
      }
    }
  }
}

Account End-Of-Day is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the account end-of-day resource.
type	string	Type of the account end-of-day resource. The value is always `accountEndOfDay`.
attributes	JSON Object	JSON object representing the account end-of-day data.
relationships	JSON:API Relationships	Describes relationships between the statement resource and other resources (account and customer).

Attributes

Name	Type	Description
date	ISO Local Date string	The date the account end-of-day resource was created.
balance	integer	The balance amount (in cents).
hold	integer	The hold amount (in cents).
available	integer	The available balance for spending (in cents).

Relationships

Field	type	Description
account	JSON:API Relationship	The account the resource belongs to.
customer	JSON:API Relationship	The individual or business customer the resource belongs to.

PinStatus

Example PinStatus resource:

{
  "data": {
    "type": "pinStatus",
    "attributes": {
      "status": "NotSet"
    }
  }
}

PinStatus is a JSON:API resource, top-level fields:

Field	type	Description
type	string	Type of the PinStatus resource. The value is always `pinStatus`.
attributes	JSON Object	JSON object representing the PinStatus data.

Attributes

Name	Type	Description
status	string	Status of the PIN, either `Set` or `NotSet`.

Check Deposit

Example CheckDeposit resource:

{
  "data": {
    "type": "checkDeposit",
    "id": "11221",
    "attributes": {
      "createdAt": "2021-05-27T09:29:30.828Z",
      "amount": 20000,
      "description": "Check deposit",
      "status": "AwaitingImages"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "account",
          "id": "10001"
        }
      },
      "customer": {
        "data": {
          "type": "customer",
          "id": "10000"
        }
      }
    }
  }
}

CheckDeposit is a JSON:API resource, top-level fields:

Field	type	Description
id	string	Identifier of the check deposit resource.
type	string	Type of the check deposit resource. The value is always `checkDeposit`.
attributes	JSON Object	JSON object representing the check deposit resource.
relationships	JSON:API Relationships	Describes relationships between the check deposit resource and other resources

Attributes

Name	Type	Description
createdAt	RFC3339 Date string	The date the resource was created.
status	string	One of `AwaitingImages`, `AwaitingFrontImage`, `AwaitingBackImage`, `Pending`, `PendingReview`, `Rejected`, `Clearing`, `Sent`, `Canceled`, `Returned`.
reason	string	(Optional) More information about the status.
description	string	Check Deposit description (maximum of 50 characters).
amount	string	The amount (cents) of the check deposit.
tags	object	See Tags.

Relationships

Name	Type	Description
account	JSON:API Relationship	The Deposit Account receiving the check deposit.
customer	JSON:API Relationship	The Customer the deposit account belongs to. The customer is either a business or a individual.
transaction	JSON:API Relationship	The Check Deposit Transaction generated by this check deposit.

Institution

Example Institution resource:

{
  "type": "institution",
  "attributes": {
    "routingNumber": "091311229",
    "name": "Choice Financial Group",
    "address": "Ste 300 Fargo ND 58104",
    "isACHSupported": true,
    "isWireSupported": false
  }
}

Institution is a JSON:API resource, top-level fields:

Field	type	Description
type	string	Type of the institution resource. The value is always `institution`.
attributes	JSON Object	JSON object representing the institution data.

Attributes

Name	Type	Description
routingNumber	string	Routing number of the institution. Valid 9-digit ABA routing transit number.
name	string	Name of the institution.
address	string	Optional. Address of the institution.
isACHSupported	boolean	Is FedACH participant.
isWireSupported	boolean	Is Fedwire participant.

Types

FullName

Example FullName type:

{
    "first": "Peter",
    "last": "Parker"
}

Field	Type	Description
first	string	Individual first name.
last	string	Individual last name.

Address

Example Address type:

{
    "street": "20 Ingram St",
    "street2": "Apt #10",
    "city": "Forest Hills",
    "state": "NY",
    "postalCode": "11375",
    "country": "US"
}

Field	Type	Description
street	string	First line of an address.
street2	string	Optional. Second line of an address.
city	string	City.
state	string	Two letters representing the state. Only required for US addresses.
postalCode	string	Postal code.
country	ISO31661-Alpha2 string	Two letters representing the country.

Phone

Example Phone type:

{
    "countryCode": "1",
    "number": "1555555555"
}

Field	Type	Description
countryCode	string	Country code of the phone number, e.g. `"1"` for US.
number	string	The phone number without the country code, e.g. `"4151193497"`.

Officer

Example Officer type:

{
    "fullName": {
        "first": "Richard",
        "last": "Hendricks"
    },	
    "dateOfBirth": "2001-08-15",
    "ssn": "721074426",
    "email": "richard@piedpiper.com",
    "phone": {
        "countryCode": "1",
        "number": "5555555"
    },
    "address": {
        "street": "5230 Newell Rd",
        "city": "Palo Alto",
        "state": "CA",
        "postalCode": "94303",
        "country": "US"
    }
}

Field	Type	Description
status	string	One of `Approved`, `Denied` or `PendingReview`.
fullName	FullName	Full name of the officer.
title	string	One of `CEO`, `COO`, `CFO` or `President`.
ssn	string	SSN of the officer (numbers only). One of `ssn` or `passport` is required.
passport	string	Passport of the officer. One of `ssn` or `passport` is required.
nationality	ISO31661-Alpha2 string	Only when Passport is populated. Two letters representing the officer's nationality.
dateOfBirth	RFC3339 Date string	Date only (e.g. `"2001-08-15"`).
address	Address	The officer's address.
phone	Phone	The officer's phone number.
email	string	The officer's email address.

BeneficialOwner

Example BeneficialOwner type:

{
    "fullName": {
        "first": "Richard",
        "last": "Hendricks"
    },	
    "dateOfBirth": "2001-08-15",
    "ssn": "721074426",
    "email": "richard@piedpiper.com",
    "phone": {
        "countryCode": "1",
        "number": "5555555"
    },
    "address": {
        "street": "5230 Newell Rd",
        "city": "Palo Alto",
        "state": "CA",
        "postalCode": "94303",
        "country": "US"
    }
}

Field	Type	Description
status	string	One of `Approved`, `Denied` or `PendingReview`.
fullName	FullName	Full name of the beneficial owner.
ssn	string	SSN of the beneficial owner (numbers only). One of `ssn` or `passport` is required.
passport	string	Passport of the beneficial owner. One of `ssn` or `passport` is required.
nationality	ISO31661-Alpha2 string	Only when Passport is populated. Two letters representing the beneficial owner's nationality.
dateOfBirth	RFC3339 Date string	Date only (e.g. `"2001-08-15"`).
address	Address	The beneficial owner's address.
phone	Phone	The beneficial owner's phone number.
email	string	The beneficial owner's email address.
percentage	integer	The beneficial owner percentage of ownership at the business (between 0 and 100).

BusinessContact

Example BusinessContact type:

{
    "fullName": {
        "first": "Richard",
        "last": "Hendricks"
    },
    "email": "richard@piedpiper.com",
    "phone": {
        "countryCode": "1",
        "number": "5555555"
    }
}

Field	Type	Description
fullName	FullName	Full name of the contact.
email	string	The contact's email address.
phone	Phone	The contact's phone number.

ApplicationFormPrefill

Example BusinessContact type:

{
  "applicationType": "Business",
  "fullName": {
    "first": "Peter",
    "last": "Parker"
  },
  "ssn": "721074426",
  "passport": "12345678",
  "nationality": "US",
  "dateOfBirth": "2001-08-10",
  "email": "peter@oscorp.com",
  "name": "Pied Piper",
  "stateOfIncorporation": "DE",
  "entityType": "Corporation",
  "contact": {
    "fullName": {
      "first": "Richard",
      "last": "Hendricks"
    },
    "email": "richard@piedpiper.com",
    "phone": {
      "countryCode": "1",
      "number": "5555555555"
    }
  },
  "officer": {
    "fullName": {
      "first": "Richard",
      "last": "Hendricks"
    },
    "dateOfBirth": "2001-08-10",
    "title": "CEO",
    "ssn": "721074426",
    "email": "richard@piedpiper.com",
    "phone": {
      "countryCode": "1",
      "number": "5555555555"
    },
    "address": {
      "street": "5230 Newell Rd",
      "city": "Palo Alto",
      "state": "CA",
      "postalCode": "94303",
      "country": "US"
    }
  },
  "beneficialOwners": [
    {
      "fullName": {
        "first": "Richard",
        "last": "Hendricks"
      },
      "dateOfBirth": "2001-08-10",
      "ssn": "123456789",
      "email": "richard@piedpiper.com",
      "percentage": 75,
      "phone": {
        "countryCode": "1",
        "number": "5555555555"
      },
      "address": {
        "street": "5230 Newell Rd",
        "city": "Palo Alto",
        "state": "CA",
        "postalCode": "94303",
        "country": "US"
      }
    }
  ],
  "website": "https://www.piedpiper.com",
  "dba": "Piedpiper Inc",
  "ein": "123456789",
  "address": {
    "street": "5230 Newell Rd",
    "city": "Palo Alto",
    "state": "CA",
    "postalCode": "94303",
    "country": "US"
  },
  "phone": {
    "countryCode": "1",
    "number": "5555555555"
  }
}

Field	Type	entity	Description
applicationType	string	All	Optional. One of `"Individual"`, `"Business"` or `"SoleProprietorship"`.
fullName	FullName	Individual	Optional. Full name of the individual.
ssn	string	Individual	Optional. SSN of the individual (numbers only). Either an SSN or a passport number is required.
passport	string	Individual	Optional. Passport number of the individual. Either an SSN or a passport is required.
nationality	ISO31661-Alpha2 string	Individual	Optional. Two letters representing the individual nationality. (e.g. “US”).
dateOfBirth	RFC3339 Date string	Individual	Optional. Date only (e.g. `"2001-08-15"`).
email	string	Individual	Optional. Email address of the individual.
name	string	Business	Optional. Name of the business.
stateOfIncorporation	string	Business	Optional. Two letters representing a US state.
entityType	string	Business	Optional. One of `"Corporation"`, `"LLC"` or `"Partnership"`.
contact	BusinessContact	Business	Optional. Primary contact of the business.
officer	Officer	Business	Optional. Officer representing the business (must be the CEO, COO, CFO, President or BenefitsAdministrationOfficer). To onboard a business successfully, you must provide the officer's personal details.
beneficialOwners	Array of BeneficialOwner	Business	Optional. Array of beneficial owners in the business. Beneficial owners are all people that, directly or indirectly, own 25% or more of the business. To onboard a business successfully, you must provide each beneficial owner's personal details.
website	string	Business	Optional. Business's website.
dba	string	Individual / Business	Optional. “Doing business as”. If the individual is a sole proprietor who is doing business under a different name, specify it here.
ein	string	Individual / Business	Optional. If the individual is a sole proprietor who has an Employer Identification Number, specify it here. / Business EIN (numbers only).
address	Address	Individual / Business	Optional. Address of the individual / Address of the business.
phone	Phone	Individual / Business	Optional. Phone number of the individual / Phone number of the business.

AuthorizedUser

Example AuthorizedUser type:

{
    "fullName": {
        "first": "Richard",
        "last": "Hendricks"
    },
    "email": "richard@piedpiper.com",
    "phone": {
        "countryCode": "1",
        "number": "5555555555"
    }
}

Field	Type	Description
fullName	FullName	Full name of the authorized user.
email	string	The authorized user's email address.
phone	Phone	The authorized user's phone number. This number will be used for One Time Password (OTP) authentication.

Counterparty

Example Counterparty type:

{
    "counterparty": {
        "routingNumber": "812345678",
        "accountNumber": "12345569",
        "accountType": "Checking",
        "name": "Jane Doe"
    }
}

Field	Type	Description
routingNumber	string	Valid 9-digit ABA routing transit number.
accountNumber	string	Bank account number.
accountType	string	Either `Checking` or `Savings`.
name	string	Name of the person or company that owns the bank account.

Coordinates

Example Coordinates type:

{
    "longitude": -77.0364,
    "latitude": 38.8951
}

Field	Type	Description
longitude	number	The longitude value.
latitude	number	The latitude value.

DeviceFingerprint

Example DeviceFingerprint type:

{
  "provider": "iovation",
  "value": "0400bpNfiPCR/AUNf94lis1ztpaNnzv+lNq30Hfp5ie720z/CiIC8ERuu3YpPgQiEVyiFhADfeGQZO28FbUrrO5N6T/KhUgGeNqKfeXqFvOptJMkxZw+Y9UPy+f0N3IyJgvEw8TWskb/j+GHTKUkZ8zWbl1IO8WxD1Kht8TqEibpebBOV3otSIldf1zxXVkhYr77KTMIYGWCBwYibAjilOCqFmMCwwZ2fQOGTEVdGJlxBwCc8acbcKqAuWf7gouzBPJaEMCy0s3hRLlX3uHnT/mMq7bvVoECdF71JNfXVRZenju64Ouq7Dncq6Dl1FsZY8jwYa/hFBBVErqVT31SgfbGSd1k0e/YM3Dtt6SI2G2F/ThwR+CXcWdbH3hXufQCF6M4Dpgq27WF46865RaUe/IZRl+rdsbATajAyMeRup82fY15RZwU9zPDpHaSwVqaWdUNw+E1ob+/FRCJ3uese38lURah37+pYGav2UwkTNot/DgwZ8YN8wmMva0q3Wpvwm165E+YRS8maek+P03Li8QHdLmZnC9N+MV7Pw1IrivGG+SXG7Fg5ZExEZyxlgiYsdKgDX8icOWPZcy4Xo6JR+o8uNh2BeaMmRyXBtJlds64QOcTfWwKrqPu/ordrByteUo8YUcRNcJsz+1j3aE1Kav6TbwSyw9pfmqz7J9hKqYUy8nou5GL7lS1H1jks3/PBPSgsZBfgyIR+XyE6hsi11FUlhkwfCqvl92YChvQ5GutOWzcgAlm5C655YuD71qCKcmZqa+c5UMfdLNXqLz+1vlqUAr9dE2jcfl0wgroQBfpyuI++K9SiDi/XDMkV0rONHETVTw2C4oQ2p6vWc20/w4QKST/riUqiozfAOitx40UDzaLaxNWMM2S8Us77dixCJm6Q57yZdeR90iPaqS7dmS/Ocl5HQBNDFBWeVaYJEF00M2y5rEDAARtF2ONlKQFMFWIfGA9WPh4380ZhZzwCZq88ApXlgSYdPkGU/BN8NSHlLSYTdGrUGXc9xYjcWtBi6X2zTt76b5csU1EK0+sD0E3ZqRPV+2/f5evS5h4cLbW2EYqYNCw25rZJOp9wXDoTKUQQlPiadkVLXwMpOFU/WEDIOxhmgTkbsvKHRH29E2Pl68vN0XpeFtRx/cjdbgHxEkRmgkRq1Qs48sbX9QC8nOTD0ntb6FcJyEOEOVzmJtDqimkzDq+SXR1/7oj0f6YtJc05sdrzcINkHr+mxLg5xX0cvFOwbohKb3xCPSKMsCJXe4s152+pJeKAyZP60EH4fIPPSI7lrfThjSC+ZC/uhKlHiPzk7Wcbftiipgbt5tQ5DBgOa5eE3shSuCUuzjuYSvn4NHYYO+c6svSooIPnW146zqeKNiPJcgsVSaircwUTU6esiGRHxaLYuc0891K2c1Zd7VesgONPiXcBur/JCDJyOWRcJ2nAB+S9dSneRnhcIA="
}

Field	Type	Description
provider	string	Provider of the device fingerprint fraud and risk prevention. The value is always `iovation`
value	string	The device fingerprint blackbox value.

Introduction

Environments

SDKs

Postman Collection

JSON Schema

Authentication

Tokens

Rate Limits

Scopes

A list of all scopes within Unit:

Tags

Tag Support

Tag Inheritance

Searching by Tags

Updating Tags

Tag Constraints

Full-Text Search

Pagination

Idempotency

Organization Accounts

Changelog

Roadmap

About JSON:API

Request and Response Structure

Resource Object

Relationships

Relationship

Getting Related Resources

Errors

Webhooks

Securing your webhooks

Ensure your server is only receiving the expected Unit requests.

Setting up your secret token

Verifying payloads from Unit

Testing

Create Webhook

Attributes

Get by Id

Response

200 OK

List

Query Parameters

Response

200 OK

Update

Attributes

Response

200 OK

Enable

Response

200 OK

Disable

Response

200 OK

Plaid

Plaid Exchange

Official Account Name

Plaid Link

How-To Guides

Helping a Customer Fund Their Account

Helping a Customer Withdraw Funds from Their Account

Helping a Customer Bill a Third Party

Helping a Customer Pay a Third Party

Org API Tokens

Create Org API Token

Attributes

Response

201 Created

List

Response

200 OK

Revoke

Response

200 OK

Customer API Tokens

How-To Guides

Allowing a customer to view their debit cards

Allowing a customer to create a new debit card (requires two-factor authentication)

Create Customer Token

Attributes