Resources

Store Location

Store Location is a JSON:API resource, top-level fields:

Name	Type	Description
type	string	Type of the Store Location resource. The value is always storeLocation.
attributes	JSON Object	JSON object representing the Store Location data.

Attributes

Name	Type	Description
storeId	string	Identifier of the retail store that supports Cash Deposits. This field will be used as storeId when Creating a Cash Deposit Barcode.
retailerName	string	Name of the retail store that supports Cash Deposits.
phone	Phone	Phone of the retail store.
address	Address	Address of the retail store.
coordinates	Coordinates	Coordinates (latitude, longitude) of the retail store.
distance	number	Distance to the retail store (in miles).

Example Store Location resource:

{
  "type": "storeLocation",
  "attributes": {
    "storeId": "4385",
    "retailerName": "CVS",
    "phone": "5163248587",
    "address": {
      "street": "38 Pantigo Rd",
      "city": "East Hampton",
      "state": "NY",
      "postalCode": "11937",
      "country": "US"
    },
    "coordinates": {
      "longitude": -72.182441,
      "latitude": 40.965453
    },
    "distance": 20.74174506966581
  }
}

---

Cash Deposit Barcode

Cash Deposit Barcode is a JSON:API resource, top-level fields:

Name	Type	Description
type	string	Type of the Cash Deposit Barcode resource. The value is always cashDepositBarcode.
attributes	JSON Object	JSON object representing the Cash Deposit Barcode data.

Attributes

Name	Type	Description
barcodeNumber	string	Unique identifier of the barcode. This field will be used in Get Barcode Image endpoint.
expiration	ISO 8601 Date and time string	The expiration date and time of the barcode
storeId	string	Identifier of the retail store that supports Cash Deposits.
retailerName	string	Name of the retailer store that supports Cash Deposits.

Relationships

Name	Type	Description
account	JSON:API Relationship	The Deposit Account designated to receive the payment.
customer	JSON:API Relationship	The Customer the deposit account belongs to.

Example Cash Deposit Barcode resource:

{
  "data": {
    "type": "cashDepositBarcode",
    "attributes": {
      "barcodeNumber": "123456789123456789000000000000",
      "expiration": "2023-12-26T13:37:23.927Z",
      "storeId": "2481",
      "retailerName": "7-Eleven"
    },
    "relationships": {
      "customer": {
        "data": {
          "type": "customer",
          "id": "10001"
        }
      },
      "account": {
        "data": {
          "type": "account",
          "id": "10002"
        }
      }
    }
  }
}

---

Cash Deposit Transaction

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

Name	Type	Description
id	string	Identifier of the transaction resource.
type	string	Type of the transaction resource. The value is always cashDepositTransaction.
attributes	JSON Object	JSON object representing the transaction data.
relationships	JSON:API Relationships	Describes relationships between the transaction resource and other resources.

Attributes

Name	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. Inherited from the payment tags (see Tag Inheritance).

Relationships

Name	Type	Description
account	JSON:API Relationship	The Deposit Account of the customer.
customer	Optional, JSON:API Relationship	The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.

Example CashDepositTransaction resource:

{
  "type": "cashDepositTransaction",
  "id": "1523",
  "attributes": {
    "createdAt": "2020-07-05T15:49:36.864Z",
    "direction": "Credit",
    "amount": 10000,
    "balance": 12000,
    "summary": "Cash deposit at Walgreens | Via card ending with 1234"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "depositAccount",
        "id": "1000"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "3"
      }
    }
  }
}