Resources
#
IndividualApplicationIndividualApplication
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). |
#
AttributesField | 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. |
updatedAt | RFC3339 Date string | Optional. The date the resource was updated. |
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. |
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. |
industry | Optional. Industry | Optional. Indicates if the individual is a sole proprietor who has an business industry, if specified. |
dba | string | Optional. Indicates if the individual is a sole proprietor who is doing business under a different name, if specified. |
archived | boolean | Indicates whether the application has been archived. Archived applications are read-only and no changes can be made to them. Once an application has been archived, a new application with the same SSN (or Passport) may be submitted. An application becomes archived once the corresponding customer is archived. |
powerOfAttorneyAgent | Agent | Optional. The details of the person that will act as the agent that has power of attorney. |
tags | object | See Tags. |
#
RelationshipsField | type | Description |
---|---|---|
documents | Array of JSON:API Relationship | Application's documents. |
customer | JSON:API Relationship | Optional. The created Customer in case of approved application. |
applicationForm | JSON:API Relationship | Optional. The ApplicationForm through which the application has been submitted. |
{ "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.", "archived": false, "tags": { "userId": "106a75e9-de77-4e25-9561-faffe59d7814" } }, "relationships": { "org": { "data": { "type": "org", "id": "1" } }, "documents": { "data": [ { "type": "document", "id": "1" }, { "type": "document", "id": "2" } ] }, "applicationForm": { "data": { "type": "applicationForm", "id": "3" } } }}
#
Reward TransactionA rewardTransaction
represents a successful reward creation.
RewardTransaction
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 rewardTransaction . |
attributes | JSON Object | JSON object representing the transaction data. |
relationships | JSON:API Relationships | Describes relationships between the transaction resource and other resources (accounts, customer, reward). |
#
AttributesField | 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, this will be the description of the reward. |
receiverCounterparty | Counterparty | The receiving party of the transaction. |
tags | object | See Tags. Inherited from the payment tags (see Tag Inheritance). |
#
RelationshipsField | 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. |
reward | JSON:API Relationship | The reward belonging to this transaction. |
receiverAccount | JSON:API Relationship | The Deposit Account receiver. |
{ "data": { "type": "rewardTransaction", "id": "51", "attributes": { "createdAt": "2022-04-05T10:46:34.371Z", "receiverCounterparty": { "name": "Unit Finance Inc.", "routingNumber": "091311229", "accountNumber": "864800000000", "accountType": "Checking" }, "amount": 800, "direction": "Credit", "balance": 113000, "summary": "My Reward 8", "tags": { "customer_type": "vip" } }, "relationships": { "account": { "data": { "type": "account", "id": "10001" } }, "customer": { "data": { "type": "customer", "id": "10000" } }, "customers": { "data": [ { "type": "customer", "id": "10000" } ] }, "org": { "data": { "type": "org", "id": "1" } }, "reward": { "data": { "type": "reward", "id": "1" } }, "receiverAccount": { "data": { "type": "account", "id": "10000" } } } }}
#
BusinessApplicationBusinessApplication
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). |
#
AttributesField | 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. |
updatedAt | RFC3339 Date string | Optional. The date the resource was updated. |
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). |
industry | Optional. Industry | Optional. Business industry, if specified. |
entityType | string | One of "Corporation" , "LLC" or "Partnership" . |
contact | BusinessContact | Primary contact of the business. |
officer | Officer | Officer representing the business, must be the CEO , COO , CFO , President , BenefitsAdministrationOfficer , CIO , VP , AVP , Treasurer , Secretary , Controller , Manager , Partner or Member . 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. |
archived | boolean | Indicates whether the application has been archived. Archived applications are read-only and no changes can be made to them. An application becomes archived once the corresponding customer is archived. |
tags | object | See Tags. |
#
RelationshipsField | type | Description |
---|---|---|
documents | Array of JSON:API Relationship | Application's documents. |
customer | JSON:API Relationship | Optional. The created Customer in case of approved application. |
applicationForm | JSON:API Relationship | Optional. The ApplicationForm through which the application has been submitted. |
{ "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" }, "archived": false, "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" } ] }, "applicationForm": { "data": { "type": "applicationForm", "id": "3" } } }}
#
TrustApplicationTrustApplication
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 trust application the value is always trustApplication . |
attributes | JSON Object | JSON object representing the application data. |
relationships | JSON:API Relationships | Describes relationships between the application resource and other resources (documents). |
#
AttributesField | type | Description |
---|---|---|
status | string | One of AwaitingDocuments , PendingReview , Approved , Denied or Pending , see Application Statuses. |
message | string | A message describing the TrustApplication status. |
createdAt | RFC3339 Date string | The date the resource was created. |
updatedAt | RFC3339 Date string | Optional. The date the resource was updated. |
name | string | Name of the trust. |
stateOfIncorporation | string | Two letters representing a US state. |
revocability | Either Revocable or Irrevocable | Whether the trust can be changed or canceled after the trust document has been signed. |
sourceOfFunds | One of Inheritance , Salary , Savings , InvestmentReturns , Gifts | Origin of the funds used to fund the account. |
taxId | string | The grantor's SSN. |
grantor | Grantor | The individual that creates the trust. |
contact | TrustContact | Primary contact of the trust. |
archived | boolean | Indicates whether the application has been archived. Archived applications are read-only and no changes can be made to them. An application becomes archived once the corresponding customer is archived. |
tags | object | See Tags. |
#
RelationshipsField | type | Description |
---|---|---|
documents | Array of JSON:API Relationship | Application's documents. |
customer | JSON:API Relationship | Optional. The created Customer in case of approved application. |
trustees | JSON:API Relationship | The trustees of the trust. |
beneficiaries | JSON:API Relationship | The beneficiaries of the trust. |
{ "type": "trustApplication", "id": "51", "attributes": { "createdAt": "2022-04-02T21:59:46.324Z", "name": "Trust me Inc.", "contact": { "fullName": { "first": "Jared", "last": "Dunn" }, "email": "jared@piedpiper.com", "phone": { "countryCode": "1", "number": "2025550108" }, "address": { "street": "5230 Newell Rd", "city": "Palo Alto", "state": "CA", "postalCode": "94303", "country": "US" } }, "status": "AwaitingDocuments", "message": "Waiting for you to upload the required documents.", "stateOfIncorporation": "CA", "revocability": "Revocable", "sourceOfFunds": "Salary", "taxId": "123456789", "grantor": { "status": "PendingReview", "fullName": { "first": "Laurie", "last": "Bream" }, "ssn": "000000003", "address": { "street": "950 Allerton Street", "city": "Redwood City", "state": "CA", "postalCode": "94063", "country": "US" }, "dateOfBirth": "2000-01-01", "email": "laurie@raviga.com", "phone": { "countryCode": "1", "number": "2025550108" } }, "tags": { "test": "test1" }, "archived": false }, "relationships": { "org": { "data": { "type": "org", "id": "1" } }, "trustees": { "data": [ { "type": "trustee", "id": "21" } ] }, "beneficiaries": { "data": [ { "type": "beneficiary", "id": "33" }, { "type": "beneficiary", "id": "34" } ] }, "documents": { "data": [ { "type": "document", "id": "201" }, { "type": "document", "id": "202" }, { "type": "document", "id": "203" } ] } }}
#
ApplicationDocumentApplicationDocument
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. |
#
AttributesField | 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 . |
{ "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" }}
#
BeneficialOwnerBeneficialOwner
is a JSON:API resource, top-level fields:
Field | type | Description |
---|---|---|
id | string | Identifier of the beneficial owner resource. |
type | string | Always beneficialOwner . |
attributes | JSON Object | JSON object representing the beneficial owner’s data. |
#
AttributesField | 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. |
string | The beneficial owner's email address. |
{ "type": "beneficialOwner", "id": "5", "attributes": { "address": { "street": "20 Ingram St", "street2": "Apt #10", "city": "Forest Hills", "state": "NY", "postalCode": "11375", "country": "US" }, "dateOfBirth": "1990-04-05", "email": "erlich@piedpiper.com", "fullName": { "first": "Erlich", "last": "Bachman" }, "phone": { "countryCode": "1", "number": "5555555555" }, "ssn": "721074426", "status": "Approved" }}
#
IndividualCustomerIndividualCustomer
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. |
string | Email address of the individual. | |
authorizedUsers | Array of AuthorizedUser | Array of authorized users. An authorized user is someone who can participate in the One Time Password (OTP) authentication process. |
status | string | Status of the customer, either Active , Archived . You can't do any write operations with Archived customers. |
archiveReason | string | Optional. The reason the account was archived, can be one of Inactive , FraudACHActivity , FraudCardActivity , FraudCheckActivity , FraudApplicationHistory , FraudAccountActivity , FraudClientIdentified , `FraudLinkedToFraudulentCustomer,. |
tags | object | See Tags. |
#
RelationshipsName | Type | Description |
---|---|---|
org | JSON:API Relationship | The Org of the individual. |
application | JSON:API Relationship | The Application that created this individual. |
{ "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" }, "status": "Active", "tags": { "userId": "106a75e9-de77-4e25-9561-faffe59d7814" } }, "relationships": { "org": { "data": { "type": "org", "id": "1" } }, "application": { "data": { "type": "individualApplication", "id": "8" } } }}
#
BusinessCustomerBusinessCustomer
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. |
#
AttributesField | 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" , "Partnership" 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. |
status | string | Status of the customer, either Active or Archived . You can't do any write operations on an Archived customer. |
archiveReason | string | Optional, only if the customer status is Archived . The reason the customer was archived, can be one of Inactive , FraudACHActivity , FraudCardActivity , FraudCheckActivity , FraudApplicationHistory , FraudAccountActivity , FraudClientIdentified , `FraudLinkedToFraudulentCustomer,. |
tags | object | See Tags. Inherited from the application tags (see Tag Inheritance). |
#
RelationshipsName | Type | Description |
---|---|---|
org | JSON:API Relationship | The Org of the business. |
application | JSON:API Relationship | The Application that created this business. |
{ "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" } } ], "status": "Active", "tags": { "userId": "106a75e9-de77-4e25-9561-faffe59d7814" } }, "relationships": { "org": { "data": { "type": "org", "id": "1" } }, "application": { "data": { "type": "businessApplication", "id": "1" } } }}
#
TrustCustomerTrustCustomer
is a JSON:API resource, describing the trust customer. Top-level fields:
Field | type | Description |
---|---|---|
id | string | Identifier of the trust resource. |
type | string | Type of the resource, the value is always trustCustomer . |
attributes | JSON Object | JSON object representing the trust data. |
relationships | JSON:API Relationships | Describes relationships between the customer resource, the Org it belongs to, and the Application it was created by. |
#
AttributesField | type | Description |
---|---|---|
createdAt | RFC3339 Date string | The date the resource was created. |
name | string | Name of the trust. |
stateOfIncorporation | string | Two letters representing a US state. |
revocability | Either Revocable or Irrevocable | Whether the trust can be changed or canceled after the trust document has been signed. |
sourceOfFunds | One of Inheritance , Salary , Savings , InvestmentReturns , Gifts | Origin of the funds used to fund the account. |
taxId | string | The grantor's SSN. |
contact | TrustContact | Primary contact of the trust. |
authorizedUsers | Array of AuthorizedUser | Array of authorized users. An authorized user is someone who can participate in the One Time Password (OTP) authentication process. |
status | string | Status of the customer, either Active or Archived . You can't do any write operations on an Archived customer. |
archiveReason | string | Optional, only if the customer status is Archived . The reason the account was archived, can be one of Inactive , FraudACHActivity , FraudCardActivity , FraudCheckActivity , FraudApplicationHistory , FraudAccountActivity , FraudClientIdentified , 'FraudLinkedToFraudulentCustomer'. |
tags | object | See Tags. Inherited from the application tags (see Tag Inheritance). |
#
RelationshipsName | Type | Description |
---|---|---|
org | JSON:API Relationship | The Org of the trust. |
application | JSON:API Relationship | The Application that created this trust. |
{ "type": "trustCustomer", "id": "52", "attributes": { "createdAt": "2022-04-02T22:14:28.574Z", "name": "Trust me Inc.", "stateOfIncorporation": "CA", "revocability": "Revocable", "sourceOfFunds": "Salary", "taxId": "123456789", "tags": { "test": "test1" }, "authorizedUsers": [ { "fullName": { "first": "Richard", "last": "Hendricks" }, "email": "richard@piedpiper.com", "phone": { "countryCode": "1", "number": "2025550108" } } ], "status": "Active", "contact": { "fullName": { "first": "Jared", "last": "Dunn" }, "email": "jared@piedpiper.com", "phone": { "countryCode": "1", "number": "2025550108" }, "address": { "street": "5230 Newell Rd", "city": "Palo Alto", "state": "CA", "postalCode": "94303", "country": "US" } } }, "relationships": { "application": { "data": { "type": "application", "id": "51" } }, "org": { "data": { "type": "org", "id": "1" } } }}
#
DepositAccountDepositAccount
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. |
#
AttributesName | Type | Description |
---|---|---|
createdAt | RFC3339 Date string | The date the resource was created. |
updatedAt | RFC3339 Date string | Optional. The date the resource was updated. |
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). The balance represents the funds that are currently in the account (not taking into account future commitments). The balance equals the sum of 'available' and 'hold'. |
hold | integer | The hold amount (in cents). The hold represents funds that are not available for spending, due to an outstanding card authorization. |
available | integer | The available balance for spending (in cents). Equals the balance minus the hold amount. |
tags | object | See Tags. |
status | string | Status of the account, either Open , Frozen , or Closed . |
freezeReason | string | Optional. The reason the account was frozen, either Fraud or free-text description. |
closeReason | string | Optional. The reason the account was closed, either ByCustomer or Fraud . |
fraudReason | string | Optional. The expanded fraud reason for closing the account when Fraud is specified as the reason. Can be one of: (ACHActivity , CardActivity , CheckActivity , ApplicationHistory , AccountActivity , ClientIdentified , IdentityTheft , LinkedToFraudulentCustomer ). |
dacaStatus | string | Optional. The account DACA (Deposit Account Control Agreements) status. Can be one of: Entered , Activated . |
note
The currency is currently always set to USD
. The balance, hold and available amounts are represented in cents.
#
RelationshipsName | Type | Description |
---|---|---|
customer | Optional, populated if account has a single owner. JSON:API Relationship | The customer. |
customers | Optional, populated if account has | |
owners. Array of JSON:API Relationship | List of customers. |
{ "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" } } }}
#
IndividualDebitCardIndividualDebitCard
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). |
#
AttributesField | type | Description |
---|---|---|
createdAt | RFC3339 Date string | The date the resource was created. |
updatedAt | RFC3339 Date string | Optional. The date the resource was updated. |
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. |
#
RelationshipsField | 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. |
{ "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" } } }}
#
BusinessDebitCardBusinessDebitCard
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). |
#
AttributesField | type | Description |
---|---|---|
createdAt | RFC3339 Date string | The date the resource was created. |
updatedAt | RFC3339 Date string | Optional. The date the resource was updated. |
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 | Optional. SSN of the card holder (numbers only), if specified during card creation. |
passport | string | Optional. Passport number of the card holder, if specified during card creation. |
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. |
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. |
#
RelationshipsField | type | Description |
---|---|---|
account | JSON:API Relationship | Account the card belong to. |
customer | JSON:API Relationship | Holder of the account. |
{ "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" } } }}
#
IndividualVirtualDebitCardIndividualVirtualDebitCard
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). |
#
AttributesField | type | Description |
---|---|---|
createdAt | RFC3339 Date string | The date the resource was created. |
updatedAt | RFC3339 Date string | Optional. The date the resource was updated. |
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 . |
#
RelationshipsField | 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. |
{ "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" } } }}
#
BusinessVirtualDebitCardBusinessVirtualDebitCard
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). |
#
AttributesField | type | Description |
---|---|---|
createdAt | RFC3339 Date string | The date the resource was created. |
updatedAt | RFC3339 Date string | Optional. The date the resource was updated. |
last4Digits | string | Last 4 digits of the debit card. |
expirationDate | string | Card expiration date, formatted YYYY-MM , e.g "2020-05" . |
ssn | string | Optional. SSN of the card holder (numbers only), if specified during card creation. |
passport | string | Optional. Passport number of the card holder, if specified during card creation. |
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. |
string | Email address of the card holder. | |
status | string | Status of the card, one of: Active , Inactive , Stolen , Lost , Frozen , ClosedByCustomer , SuspectedFraud . |
#
RelationshipsField | type | Description |
---|---|---|
account | JSON:API Relationship | Account the card belong to. |
customer | JSON:API Relationship | Holder of the account. |
{ "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" } } }}
#
Counterparty BalanceCounterparty
is a JSON:API resource, top-level fields:
Field | type | Description |
---|---|---|
id | string | Identifier of the Counterparty. |
type | string | Type of the balance. for counterparty balance the value is always counterpartyBalance. |
attributes | JSON Object | JSON object representing the counterparty balance resource. |
relationships | JSON:API Relationships | Describes relationships between the counterparty balance and the customer and counterparty. |
#
AttributesName | Type | Description |
---|---|---|
balance | number | The current balance amount (in cents) of the counterparty. |
available | number | Optional. The available balance amount (in cents) of the counterparty. |
#
RelationshipsName | Type | Description |
---|---|---|
counterparty | JSON:API Relationship | The counterparty the balance belongs to. |
customer | JSON:API Relationship | The customer the counterparty belongs to. |
{ "data": { "type": "counterpartyBalance", "id": "2", "attributes": { "balance": 11000, "available": 10000 }, "relationships": { "counterparty": { "data": { "type": "counterparty", "id": "2" } }, "customer": { "data": { "type": "customer", "id": "10000" } } } }}
#
ACH CounterpartyCounterparty
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. |
#
AttributesName | 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 . |
#
RelationshipsName | Type | Description |
---|---|---|
customer | JSON:API Relationship | The customer the counterparty belongs to. |
{ "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" } } }}
#
ACH PaymentAchPayment
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. |
#
AttributesName | Type | Description |
---|---|---|
createdAt | RFC3339 Date string | The date the resource was created. |
status | string | One of Pending ,Pending Review , 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 | integer | The amount (cents) of the payment. |
settlementDate | RFC3339 Date string | Optional, For ACH debit with statuses Pending ,Clearing , shows the date on which the payment will be settled. |
expectedCompletionDate | RFC3339 Date string | Optional, For ACH credit with statuses Pending ,Sent , shows the date on which the counterparty will handle the request. |
tags | object | See Tags. |
#
RelationshipsName | Type | Description |
---|---|---|
account | JSON:API Relationship | The Deposit Account originating the transfer. |
customer | OptionalJSON: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. |
counterparty | JSON:API Relationship | The Counterparty the payment to be made to. |
transaction | JSON:API Relationship | Optional. The transaction generated by this payment. Generated instantly in cases where a credit ach payment is converted to a book payment, otherwise, once the payment is sent. |
recurringPayment | Optional, JSON:API Relationship | The recurring payment belonging to this payment. |
{ "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" } } } }}
#
Recurring Credit ACH PaymentRecurringCreditAchPayment
is a JSON:API resource, top-level fields:
Field | type | Description |
---|---|---|
id | string | Identifier of the recurring Credit ACH payment resource. |
type | string | Type of the payment resource. For credit ach recurring payments the value is recurringCreditAchPayment . |
attributes | JSON Object | JSON object representing the recurring payment resource. |
relationships | JSON:API Relationships | Describes relationships between the Recurring Credit ACH payment and the originating deposit account and org. |
#
AttributesName | Type | Description |
---|---|---|
createdAt | RFC3339 Date string | The date the resource was created. |
updatedAt | RFC3339 Date string | The date the resource was updated. |
amount | integer | The amount (cents) of the 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. |
status | string | Status of the recurring payment, one of: Active , Completed , Disabled . |
numberOfPayments | integer | Represents the number of payments that were created by this recurring payment. |
schedule | Schedule | The schedule of the recurring payment. |
tags | object | See Tags. |
#
RelationshipsName | Type | Description |
---|---|---|
account | JSON:API Relationship | The Deposit Account originating the recurring payment. |
org | JSON:API Relationship | The org the customer belongs to. |
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. |
counterparty | JSON:API Relationship | The Counterparty the payment to be made to. |
{ "data": { "type": "recurringCreditAchPayment", "id": "1", "attributes": { "createdAt": "2022-06-25T08:50:49.391Z", "updatedAt": "2022-06-25T08:50:49.391Z", "amount": 1000, "description": "Rent - Apartment 15", "schedule": { "startTime": "2022-06-25", "interval": "Monthly", "nextScheduledAction": "2022-07-18", "dayOfMonth": 16 }, "status": "Active", "numberOfPayments": 0 }, "relationships": { "counterparty": { "data": { "type": "counterparty", "id": "1" } }, "account": { "data": { "type": "account", "id": "10002" } }, "customer": { "data": { "type": "customer", "id": "10004" } }, "org": { "data": { "type": "org", "id": "1" } } } }}
#
Book PaymentBookPayment
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 Book payment and the originating deposit account and customer. |
#
AttributesName | 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. |
transactionSummaryOverride | string | If this field is populated, its contents will be returned as the bookTransaction’s summary field (maximum of 100 characters). |
amount | string | The amount (cents) of the payment. |
tags | object | See Tags. |
#
RelationshipsName | Type | Description |
---|---|---|
account | JSON:API Relationship | The Deposit Account creating the payment. |
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 a multiple individual customers. |
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 an individual, might be empty if there is more than one associated customer. |
transaction | JSON:API Relationship | The Book Transaction generated by this payment. |
recurringPayment | Optional, JSON:API Relationship | The recurring payment belonging to this payment. |
{ "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" } } } }}
#
Recurring Credit Book PaymentRecurringCreditBookPayment
is a JSON:API resource, top-level fields:
Field | type | Description |
---|---|---|
id | string | Identifier of the recurring credit book payment resource. |
type | string | Type of the payment resource. The value is always recurringCreditBookPayment . |
attributes | JSON Object | JSON object representing the payment resource. |
relationships | JSON:API Relationships | Describes relationships between the recurring credit book payment and the originating deposit account and org. |
#
AttributesName | Type | Description |
---|---|---|
createdAt | RFC3339 Date string | The date the resource was created. |
updatedAt | RFC3339 Date string | The date the resource was updated. |
amount | string | The amount (cents) of the payment. |
description | string | Payment description (maximum of 50 characters), this will show up on statement of the counterparty. |
status | string | Status of the recurring payment, one of: Active , Completed , Disabled . |
numberOfPayments | integer | Represents the number of payments that were created by this recurring payment. |
schedule | Schedule | The schedule of the recurring payment. |
transactionSummaryOverride | string | If this field is populated, its contents will be returned as the bookTransaction’s summary field (maximum of 100 characters). |
tags | object | See Tags. |
#
RelationshipsName | Type | Description |
---|---|---|
account | JSON:API Relationship | The Deposit Account creating the recurring payment. |
counterpartyAccount | JSON:API Relationship | The Counterparty account the payment to be made to. |
org | JSON:API Relationship | The org the customer belongs to. |
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. |
{ "data": { "type": "recurringCreditBookPayment", "id": "4", "attributes": { "createdAt": "2022-06-25T14:27:41.093Z", "updatedAt": "2022-06-25T14:27:41.093Z", "amount": 40, "description": "Subscription - Basic Plan", "schedule": { "startTime": "2022-06-25", "interval": "Monthly", "nextScheduledAction": "2022-07-05", "dayOfMonth": 5 }, "status": "Active", "tags": { "test": "test" }, "numberOfPayments": 0 }, "relationships": { "org": { "data": { "type": "org", "id": "1" } }, "account": { "data": { "type": "account", "id": "10002" } }, "counterpartyAccount": { "data": { "type": "account", "id": "10000" } }, "customer": { "data": { "type": "customer", "id": "10004" } } } }}
#
Wire PaymentWirePayment
is a JSON:API resource, top-level fields:
Field | type | Description |
---|---|---|
id | string | Identifier of the wire payment resource. |
type | string | Type of the payment resource. The value is always wirePayment . |
attributes | JSON Object | JSON object representing the payment resource. |
relationships | JSON:API Relationships | Describes relationships between the Wire payment and the originating deposit account, customer and transaction. |
#
AttributesName | Type | Description |
---|---|---|
createdAt | RFC3339 Date string | The date the resource was created. |
status | string | Either Pending , Returned , Sent or Rejected (see reason for details). |
reason | string | Optional. More information about the status. |
direction | string | The direction in which the funds flow (Credit only). |
description | string | Payment description (maximum of 50 characters), this will show up on statement of the counterparty. |
counterparty | Wire Counterparty | The beneficiary party on the other end of the payment. |
amount | string | The amount (cents) of the payment. |
tags | object | See Tags. |
imadOmad | object | (Conditional) IMAD/OMAD - Input/Output Message Accountability Data. It's a unique number given to each FedWire payment in case of payment has been sent and fully processed. |
#
RelationshipsName | Type | Description |
---|---|---|
account | JSON:API Relationship | The Deposit Account creating the payment. |
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 a multiple individual customers. |
transaction | JSON:API Relationship | The Wire Transaction generated by this payment. |
{ "data": { "type": "wirePayment", "id": "3", "attributes": { "createdAt": "2021-10-05T06:33:45.035Z", "amount": 200, "direction": "Credit", "description": "Wire payment", "counterparty": { "name": "April Oniel", "routingNumber": "812345678", "accountNumber": "1000000001", "address": { "street": "20 Ingram St", "city": "Forest Hills", "state": "CA", "postalCode": "11375", "country": "US" } }, "status": "Sent", "imadOmad": { "imad": "123456", "omad": "654321" } }, "relationships": { "account": { "data": { "type": "account", "id": "10000" } }, "customer": { "data": { "type": "customer", "id": "10000" } }, "customers": { "data": [ { "type": "customer", "id": "10000" } ] }, "transaction": { "data": { "type": "transaction", "id": "1" } } } }}
#
Bill PaymentBillPayment
is a JSON:API resource, top-level fields:
Field | type | Description |
---|---|---|
id | string | Identifier of the bill payment resource. |
type | string | Type of the payment resource. The value is always billPayment . |
attributes | JSON Object | JSON object representing the payment resource. |
relationships | JSON:API Relationships | Describes relationships between the payment and the originating deposit account and customer. |
#
AttributesName | Type | Description |
---|---|---|
createdAt | RFC3339 Date string | The date the resource was created. |
status | string | Either Sent , Pending or Rejected (see reason for details). |
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 | number | The amount (cents) of the payment. |
tags | object | See Tags. |
#
RelationshipsName | Type | Description |
---|---|---|
account | JSON:API Relationship | The Deposit Account creating the payment. |
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, butisness 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 a multiple individual customers. |
transaction | JSON:API Relationship | The BillPay Transaction generated by this payment. |
{ "data": { "type": "billPayment", "id": "6345", "attributes": { "createdAt": "2021-08-17T12:20:45.040Z", "amount": 2400, "direction": "Credit", "description": "Water Bill payment June", "status": "Pending" }, "relationships": { "account": { "data": { "type": "account", "id": "95032" } }, "customer": { "data": { "type": "customer", "id": "55332" } } } }}
#
ACH Received PaymentAchReceivedPayment
is a JSON:API resource, top-level fields:
Field | type | Description |
---|---|---|
id | string | Identifier of the received payment resource. |
type | string | Type of the transaction resource. The value is always achReceivedPayment . |
attributes | JSON Object | JSON object representing the transaction data. |
relationships | JSON:API Relationships | Describes relationships between the transaction resource and other resources (account, customer related transactions). |
#
AttributesField | type | Description |
---|---|---|
createdAt | RFC3339 Date string | The date the transaction was created. Common to all receive payment types. |
status | string | The status of the Received Payment. One of Pending , Advanced , Completed or Returned , see ReceivedPayment Statuses. Common to all received payment types. |
wasAdvanced | boolean | Will be true if the received payment was or is being Advanced (has or has had the status Advanced ). Common to all received payment types. |
completionDate | RFC3339 Date string | Shows the date on which the received ACH will be completed(settled or repaid). |
returnReason | string | Optional. The reason if the received payment is Returned . See ACH return reasons. |
amount | integer | The amount (cents) of the ACH received payment. Common to all received payment types. |
description | string | ACH description (maximum of 10 characters), also known as Company Entry 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 received 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. |
#
RelationshipsField | type | Description |
---|---|---|
account | JSON:API Relationship | The Deposit Account of the customer. |
customer | Optional, JSON:API Relationship | The Customer the deposit account belongs to, business or individual. |
receivePaymentTransaction | Optional, JSON:API Relationship | The transaction of the received payment, created due to advance or when the ACH is processed. |
paymentAdvanceTransaction | Optional, JSON:API Relationship | The transaction that funded the Advance from the provisional credit operating account, if the received payment was advanced. |
repayPaymentAdvanceTransaction | Optional, JSON:API Relationship | The transaction that repaid the advance once the received payment is completed. |
{ "type": "achReceivedPayment", "id": "1337", "attributes": { "createdAt": "2022-02-01T12:03:14.406Z", "status": "Completed", "wasAdvanced": true, "amount": 100000, "completionDate": "2022-01-23", "companyName": "Uber", "counterpartyRoutingNumber": "051402372", "description": "Sandbox Transaction", "traceNumber": "123456789123456", "secCode": "PPD", "tags": {} }, "relationships": { "account": { "data": { "type": "account", "id": "163555" } }, "customer": { "data": { "type": "customer", "id": "129522" } }, "receivePaymentTransaction": { "data": { "type": "transaction", "id": "101" } }, "paymentAdvanceTransaction": { "data": { "type": "transaction", "id": "202" } }, "repayPaymentAdvanceTransaction": { "data": { "type": "transaction", "id": "890" } } }}
#
Declined Incoming PaymentDeclinedIncomingPayment
is a JSON:API resource, top-level fields:
Field | type | Description |
---|---|---|
id | string | Identifier of the declined incoming payment resource. |
type | string | Type of the declined incoming payment resource. The value is always declinedIncomingPayment . |
attributes | JSON Object | JSON object representing the declined incoming payment resource. |
relationships | JSON:API Relationships | Describes relationships between the declined incoming payment and the originating deposit account and customer. |
#
AttributesName | Type | Description |
---|---|---|
createdAt | RFC3339 Date string | The date the resource was created. |
reason | string | The reason for the transaction return. See ACH return reasons. |
direction | string | The direction in which the funds flow (either Debit or Credit ). |
amount | integer | The amount (cents) of the payment. |
type | string | Type of the payment resource. |
Currently only AchPayment
payment type is supported.
#
RelationshipsName | Type | Description |
---|---|---|
account | JSON:API Relationship | The Deposit Account originating the transfer. |
customer | OptionalJSON: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. |
{ "data": { "type": "declinedIncomingPayment", "id": "1", "attributes": { "direction": "Credit", "amount": 10000, "reason": "NoAccount", "paymentType": "AchPayment", "createdAt": "2020-01-13T16:01:19.346Z" }, "relationships": { "account": { "data": { "type": "account", "id": "555" } }, "customer": { "data": { "type": "customer", "id": "99823" } } } }}
#
Originated ACH TransactionOriginatedAchTransaction
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). |
#
AttributesField | 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. |
counterparty | Counterparty | The party on the other end of the transaction. |
tags | object | See Tags. Inherited from the payment tags (see Tag Inheritance). |
#
RelationshipsField | 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. |
payment | JSON:API Relationship | The payment belonging to this transaction. |
recurringPayment | Optional, JSON:API Relationship | The recurring payment belonging to this transaction. |
{ "type": "originatedAchTransaction", "id": "1", "attributes": { "createdAt": "2020-09-06T07:51:02.570Z", "direction": "Credit", "amount": 10000, "balance": 10000, "summary": "Unit Inc | Initial account funding", "description": "Funding", "addenda": "Initial account 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" } } }}
#
Received ACH TransactionReceivedAchTransaction
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). |
#
AttributesField | 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. |
#
RelationshipsField | 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. |
{ "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" } } }}
#
Returned ACH TransactionReturnedAchTransaction
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). |
#
AttributesField | 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. See ACH return reasons. |
tags | object | See Tags. |
#
RelationshipsField | 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. |
payment | JSON:API Relationship | The returned payment. |
{ "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" } } }}
#
Returned Received ACH TransactionThe transaction represents a received ACH that has been returned, automatically by Unit (e.g insufficient funds), by a dispute, or manually via a 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 returnedReceivedAchTransaction . |
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). |
#
AttributesField | 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. See ACH return reasons. |
tags | object | See Tags. |
#
RelationshipsField | 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. |
returned | JSON:API Relationship | The returned transaction. |
{ "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" } } }}
#
Dishonored ACH TransactionA dishonored ACH transaction is a relatively uncommon transaction type, that happens when Unit attempts to return a received ACH, but the originating bank decides not to return the funds. This typically happens when the return is not in compliance with the NACHA rules (e.g. 3 days after the payment took place when the network rules define a maximum of 2 days).
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 dishonoredAchTransaction . |
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). |
#
AttributesField | 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. |
#
RelationshipsField | 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. |
{ "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" } } }}
#
Book TransactionBookTransaction
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). |
#
AttributesField | 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. |
tags | object | See Tags. Inherited from the payment tags (see Tag Inheritance). |
#
RelationshipsField | 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. |
counterpartyAccount | JSON:API Relationship | The account of the counterparty. |
counterpartyCustomer | JSON:API Relationship | The counterparty customer. |
payment | Optional, JSON:API Relationship | The payment belonging to this transaction. |
recurringPayment | Optional, JSON:API Relationship | The recurring payment belonging to this transaction. |
{ "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" } }, "payment": { "data": { "type": "payment", "id": "10000" } } }}
#
Purchase TransactionPurchaseTransaction
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). |
#
AttributesField | 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. |
interchange | number | Optional. The interchange share for this transaction. Calculated at the end of each day, see the transaction.updated event. |
ecommerce | boolean | Indicates whether the transaction was created over an electronic network (primarily the internet). |
cardPresent | boolean | Indicates whether the card was present when the transaction was created. |
paymentMethod | string | Optional. The payment method used, one of: Manual , Swipe , Contactless , ChipAndPin , Stored , Other . |
digitalWallet | string | Optional. The type of digital wallet used, one of: Google , Apple , Other . |
cardVerificationData.verificationMethod | string | Optional. The verification method used, one of: Address , CVV2 , AddressAndCVV2 . |
cardNetwork | string | Optional. The card network used, one of: Visa , Interlink , Accel , Allpoint , Other . |
tags | object | See Tags. Inherited from the authorization request tags (see Tag Inheritance). |
#
RelationshipsField | 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. |
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). |
authorizationRequest | Optional, JSON:API Relationship | The preceding authorization request, if present (see Authorization Requests). |
{ "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, "interchange": "2.43", "ecommerce": false, "cardPresent": true, "paymentMethod": "Contactless", "digitalWallet": "Apple", "cardVerificationData": { "verificationMethod": "CVV2" }, "cardNetwork": "Visa" }, "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" } } }}
#
ATM TransactionAtmTransaction
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). |
#
AttributesField | 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. |
interchange | number | Optional. The interchange share for this transaction. Calculated at the end of each day, see the transaction.updated event. |
cardNetwork | string | Optional. The card network used, one of: Visa , Interlink , Accel , Allpoint , Other . |
tags | object | See Tags. |
#
RelationshipsField | 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. |
card | JSON:API Relationship | The debit card involved in the transaction. |
{ "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, "cardNetwork": "Allpoint" }, "relationships": { "account": { "data": { "type": "depositAccount", "id": "1000" } }, "customer": { "data": { "type": "customer", "id": "3" } }, "card": { "data": { "type": "card", "id": "11" } } }}
#
Fee TransactionFeeTransaction
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). |
#
AttributesField | 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. |
#
RelationshipsField | 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. |
relatedTransaction | JSON:API Relationship | Optional. The transaction which the fee is subject to. |
{ "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" } } }}
#
Card Reversal TransactionCardReversalTransaction
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). |
#
AttributesField | 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. |
#
RelationshipsField | 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. |
relatedTransaction | JSON:API Relationship | Optional. The transaction which the reversal is related to. |
{ "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" } } }}
#
Card TransactionA transaction that represents various card transactions that are not Purchase or ATM transactions. Most commonly, these transactions represent peer-to-peer payments (e.g. Venmo, CashApp) and gig economy employee payouts (ride sharing, deliveries, etc).
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). |
#
AttributesField | 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 | Optional. The name of the merchant. |
merchant.type | integer | Optional. The 4-digit ISO 18245 merchant category code (MCC). |
merchant.category | string | Optional. 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 | Optional. Indicates whether the transaction is recurring. |
interchange | number | Optional. The interchange share for this transaction. Calculated at the end of each day, see the transaction.updated event. |
paymentMethod | string | Optional. The payment method used, one of: Manual , Swipe , Contactless , ChipAndPin , Stored , Other . |
digitalWallet | string | Optional. The type of digital wallet used, one of: Google , Apple , Other . |
cardVerificationData.verificationMethod | string | Optional. The verification method used, one of: Address , CVV2 , AddressAndCVV2 . |
cardNetwork | string | Optional. The card network used, one of: Visa , Interlink , Accel , Allpoint , Other . |
tags | object | See Tags. |
#
RelationshipsField | 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. |
{ "type": "cardTransaction", "id": "410", "attributes": { "createdAt": "2020-09-20T12:41:43.360Z", "direction": "Debit", "amount": 10, "balance": 89480, "summary": "Card transaction details", "cardLast4Digits": "2282", "merchant": { "name": "Europcar Mobility Group", "type": 3381, "category": "EUROP CAR", "location": "Cupertino, CA" }, "recurring": false, "interchange": 2.43, "paymentMethod": "Contactless", "digitalWallet": "Apple", "cardVerificationData": { "verificationMethod": "CVV2" }, "cardNetwork": "Visa" }, "relationships": { "account": { "data": { "type": "account", "id": "10001" } }, "customer": { "data": { "type": "customer", "id": "1001" } } }}
#
Wire TransactionWireTransaction
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. |
Attributes | ||
relationships | JSON:API Relationships | Describes relationships between the transaction resource and other resources (account and customer). |
#
AttributesField | 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. |
originatorToBeneficiaryInformation | string | Originator To Beneficiary Information, multi-line string delimited by \n . |
senderReference | string | Sender reference. |
referenceForBeneficiary | string | Reference for the Beneficiary. |
beneficiaryInformation | string | Beneficiary Information, multi-line string delimited by \n . |
beneficiaryAdviceInformation | string | Beneficiary Advice Information, multi-line string delimited by \n . |
tags | object | See Tags. |
#
RelationshipsField | 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. |
{ "type": "wireTransaction", "id": "9547", "attributes": { "createdAt": "2020-07-05T15:49:36.864Z", "direction": "Credit", "amount": 1000, "balance": 12000, "summary": "Wire to 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" } } }}
#
Release TransactionReleaseTransaction
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). |
#
AttributesField | 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. |
#
RelationshipsField | type | Description |
---|---|---|
account | JSON:API Relationship | The Deposit Account receiving the funds. |
{ "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" } } }}
#
Adjustment TransactionAdjustmentTransaction
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). |
#
AttributesField | 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. |
#
RelationshipsField | type | Description |
---|---|---|
account | JSON:API Relationship | The Deposit Account participating in the transaction. |
{ "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" } } }}
#
Interest TransactionInterestTransaction
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). |
#
AttributesField | 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. |
#
RelationshipsField | 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. |
{ "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" } } }}
#
Dispute TransactionDisputeTransaction
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, disputedTransaction). |
#
AttributesField | 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. |
disputeId | string | Unique ID of the dispute that is related to the transaction. |
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. |
#
RelationshipsField | type | Description |
---|---|---|
account | JSON:API Relationship | The Deposit Account participating in the transaction. |
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. |
disputedTransaction | Optional, JSON:API Relationship | The transaction that has been disputed. |
{ "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" } }, "disputedTransaction": { "data": { "type": "transaction", "id": "6" } } }}
#
Check Deposit TransactionCheckDepositTransaction
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). |
#
AttributesField | 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. |
#
RelationshipsField | type | Description |
---|---|---|
account | JSON:API Relationship | The Deposit Account participating in the transaction. |
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. |
checkDeposit | JSON:API Relationship | The Check Deposit the transaction is related to. |
{ "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" } } } }}
#
Returned Check Deposit TransactionReturnedCheckDepositTransaction
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). |
#
AttributesField | 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. |
#
RelationshipsField | type | Description |
---|---|---|
account | JSON:API Relationship | The Deposit Account participating in the transaction. |
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. |
checkDeposit | JSON:API Relationship | The Check Deposit the transaction is related to. |
{ "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" } } } }}
#
Payment Canceled TransactionThe transaction represents an originated ACH that has been canceled by its originator prior to its transmission to the ACH network.
PaymentCanceledTransaction
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 paymentCanceledTransaction . |
attributes | JSON Object | JSON object representing the transaction data. |
relationships | JSON:API Relationships | Describes relationships between the transaction resource and other resources (account, customer). |
#
AttributesField | 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. |
#
RelationshipsField | type | Description |
---|---|---|
account | JSON:API Relationship | The Deposit Account participating in the transaction. |
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. |
org | JSON:API Relationship | The org the customer belongs to. |
relatedTransaction | JSON:API Relationship | The original transaction being canceled. |
{ "type": "paymentCanceledTransaction", "id": "185", "attributes": { "createdAt": "2022-02-02T13:11:22.404Z", "amount": 7000, "direction": "Credit", "balance": 1702108, "summary": "Cancellation of: 184 | Payment Id: 18" }, "relationships": { "account": { "data": { "type": "account", "id": "10002" } }, "customer": { "data": { "type": "customer", "id": "10001" } }, "customers": { "data": [ { "type": "customer", "id": "10001" } ] }, "relatedTransaction": { "data": { "type": "transaction", "id": "184" } } }}
#
Payment Advance TransactionPaymentAdvanceTransaction
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 paymentAdvanceTransaction . |
attributes | JSON Object | JSON object representing the transaction data. |
relationships | JSON:API Relationships | Describes relationships between the transaction resource and other resources (account, customer, receivedPayment). |
#
AttributesField | 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. The value is always Debit . |
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. |
#
RelationshipsField | type | Description |
---|---|---|
account | JSON:API Relationship | The Deposit Account participating in the transaction. |
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. |
receivedPayment | JSON:API Relationship | The ReceivedPayment that was advanced and funded with this transaction. |
{ "type": "paymentAdvanceTransaction", "id": "226", "attributes": { "createdAt": "2021-04-19T12:44:08.055Z", "amount": 2500, "direction": "Debit", "balance": 550000, "summary": "Advance for ReceivedPayment with id 6", "tags": { "trackingId": "106a75e9-de77-4e25-9561-faffe59d7814" } }, "relationships": { "account": { "data": { "type": "account", "id": "10001" } }, "customer": { "data": { "type": "customer", "id": "10000" }, "receivedPayment": { "data": { "type": "receivedPayment", "id": "6" } } } }}
#
Repaid Payment Advance TransactionRepaidPaymentAdvanceTransaction
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 repaidPaymentAdvanceTransaction . |
attributes | JSON Object | JSON object representing the transaction data. |
relationships | JSON:API Relationships | Describes relationships between the transaction resource and other resources (account, customer, related transaction, receivedPayment). |
#
AttributesField | 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. The value is always Credit . |
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. |
#
RelationshipsField | type | Description |
---|---|---|
account | JSON:API Relationship | The Deposit Account participating in the transaction. |
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. |
receivedPayment | JSON:API Relationship | The ReceivedPayment that was previously advanced and now completed (and repaid) . |
paymentAdvanceTransaction | JSON:API Relationship | The transaction that Debit the account for the advance that this repayment is related to. |
{ "type": "repaidPaymentAdvanceTransaction", "id": "226", "attributes": { "createdAt": "2021-04-19T12:44:08.055Z", "amount": 2500, "direction": "Credit", "balance": 550000, "summary": "Repayment for Advance Transaction with id 101 of ReceivedPayment with id 6", "tags": { "trackingId": "106a75e9-de77-4e25-9561-faffe59d7814" } }, "relationships": { "account": { "data": { "type": "account", "id": "10001" } }, "customer": { "data": { "type": "customer", "id": "10000" }, "receivedPayment": { "data": { "type": "receivedPayment", "id": "6" } }, "paymentAdvanceTransaction": { "data": { "type": "transaction", "id": "101" } } } }}
#
Chargeback TransactionchargebackTransaction
is a type of transaction that is generated when a Chargeback request
is initiated.
ChargebackTransaction
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 chargebackTransaction . |
attributes | JSON Object | JSON object representing the transaction data. |
relationships | JSON:API Relationships | Describes relationships between the transaction resource and other resources (accounts, customer, chargeback). |
#
AttributesField | 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, this will be the description of the chargeback. |
counterparty | Counterparty | The party on the other end of the transaction. |
tags | object | See Tags. Inherited from the payment tags (see Tag Inheritance). |
#
RelationshipsField | 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. |
counterpartyAccount | JSON:API Relationship | The account of the counterparty. |
chargeback | JSON:API Relationship | The chargeback belonging to this transaction. |
{ "type": "chargebackTransaction", "id": "9547", "attributes": { "createdAt": "2020-07-05T15:49:36.864Z", "direction": "Debit", "amount": 1000, "balance": 12000, "summary": "Chargeback for dispute #1337", "counterparty": { "name": "Jane Smith", "routingNumber": "812345678", "accountNumber": "10039", "accountType": "Checking" }, "tags": { "internalId": "abc1345" } }, "relationships": { "account": { "data": { "type": "account", "id": "10035" } }, "customer": { "data": { "type": "customer", "id": "10000" } }, "customers": { "data": [ { "type": "customer", "id": "10000" } ] }, "counterpartyAccount": { "data": { "type": "account", "id": "10036" } }, "chargeback": { "data": { "type": "chargeback", "id": "10530" } } }}
#
AuthorizationAuthorization
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). |
#
AttributesField | 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. |
status | string | One of Authorized , Completed , Canceled , Declined , see Authorization Statuses. |
declineReason | string | Optional. The reason the authorization was declined. 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 |
paymentMethod | string | Optional. The payment method used, one of: Manual , Swipe , Contactless , ChipAndPin , Stored , Other . |
digitalWallet | string | Optional. The type of digital wallet used, one of: Google , Apple , Other . |
cardVerificationData.verificationMethod | string | Optional. The verification method used, one of: Address , CVV2 , AddressAndCVV2 . |
cardNetwork | string | Optional. The card network used, one of: Visa , Interlink , Accel , Allpoint , Other . |
tags | object | See Tags. Inherited from the authorization request tags (see Tag Inheritance). |
#
RelationshipsField | 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. |
card | JSON:API Relationship | The debit card involved in the authorization. |
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. |
authorizationRequest | Optional, JSON:API Relationship | The preceding authorization request, if present (see Authorization Requests). |
{ "type": "authorization", "id": "97", "attributes": { "createdAt": "2021-02-21T07:29:42.447Z", "amount": 2000, "cardLast4Digits": "0019", "status": "Authorized", "merchant": { "name": "Europcar Mobility Group", "type": 3381, "category": "EUROP CAR", "location": "Cupertino, CA" }, "recurring": false, "paymentMethod": "Contactless", "digitalWallet": "Apple", "cardVerificationData": { "verificationMethod": "CVV2" }, "cardNetwork": "Visa" }, "relationships": { "customer": { "data": { "type": "customer", "id": "10000" } }, "account": { "data": { "type": "account", "id": "10001" } }, "card": { "data": { "type": "card", "id": "10501" } } }}
#
Purchase Authorization RequestPurchaseAuthorizationRequest
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). |
#
AttributesField | 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 |
ecommerce | boolean | Optional. Indicates whether the transaction was created over an electronic network (primarily the internet). |
cardPresent | boolean | Optional. Indicates whether the card was present when the transaction was created. |
paymentMethod | string | Optional. The payment method used, one of: Manual , Swipe , Contactless , ChipAndPin , Stored , Other . |
digitalWallet | string | Optional. The type of digital wallet used, one of: Google , Apple , Other . |
cardVerificationData. verificationMethod | string | Optional. The verification method used, one of: Address , CVV2 , AddressAndCVV2 . |
cardNetwork | string | Optional. The card network used, one of: Visa , Interlink , Accel , Allpoint , Other . |
healthcareAmounts | Healthcare Amounts | Optional. IIAS related data for FSA/HRA enabled cards. |
tags | object | Optional, See Tags. If specified when approving the authorization request. |
#
RelationshipsField | 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. |
card | JSON:API Relationship | The debit card used in the purchase. |
fundingAccount | Optional, JSON:API Relationship | An alternate Deposit Account that will be used for funding the transaction. |
{ "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, "paymentMethod": "Contactless", "digitalWallet": "Apple", "cardVerificationData": { "verificationMethod": "CVV2" }, "ecommerce": true, "cardPresent": false, "cardNetwork": "Visa" }, "relationships": { "customer": { "data": { "type": "customer", "id": "10000" } }, "account": { "data": { "type": "account", "id": "10001" } }, "card": { "data": { "type": "card", "id": "7" } } }}
#
Card Transaction Authorization RequestCardTransactionAuthorizationRequest
is a JSON:API resource, top-level fields:
Field | type | Description |
---|---|---|
id | string | Identifier of the card transaction authorization request resource. |
type | string | Type of the card transaction authorization request resource. The value is always cardTransactionAuthorizationRequest . |
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). |
#
AttributesField | 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 |
paymentMethod | string | Optional. The payment method used, one of: Manual , Swipe , Contactless , ChipAndPin , Stored , Other . |
digitalWallet | string | Optional. The type of digital wallet used, one of: Google , Apple , Other . |
cardVerificationData. verificationMethod | string | Optional. The verification method used, one of: Address , CVV2 , AddressAndCVV2 . |
cardNetwork | string | Optional. The card network used, one of: Visa , Interlink , Accel , Allpoint , Other . |
tags | object | Optional, See Tags. If specified when approving the authorization request. |
#
RelationshipsField | 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. |
card | JSON:API Relationship | The debit card used in the transaction. |
fundingAccount | Optional, JSON:API Relationship | An alternate Deposit Account that will be used for funding the transaction. |
{ "type": "cardTransactionAuthorizationRequest", "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, "paymentMethod": "Contactless", "digitalWallet": "Apple", "cardVerificationData": { "verificationMethod": "CVV2" }, "cardNetwork": "Visa" }, "relationships": { "customer": { "data": { "type": "customer", "id": "10000" } }, "account": { "data": { "type": "account", "id": "10001" } }, "card": { "data": { "type": "card", "id": "7" } } }}
#
ATM Authorization RequestAtmAuthorizationRequest
is a JSON:API resource, top-level fields:
Field | type | Description |
---|---|---|
id | string | Identifier of the authorization request resource. |
type | string | Type of the authorization request resource. The value is always atmAuthorizationRequest . |
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). |
#
AttributesField | 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 |
direction | string | The direction in which the funds flow (either Debit or Credit ). |
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. |
internationalServiceFee | number | Optional. The fee (cents) for international transactions. |
cardNetwork | string | Optional. The card network used, one of: Visa , Interlink , Accel , Allpoint , Other . |
tags | object | See Tags. |
#
RelationshipsField | 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. |
card | JSON:API Relationship | The debit card used in the purchase. |
{ "type": "atmAuthorizationRequest", "id": "1", "attributes": { "createdAt": "2021-06-22T13:39:17.018Z", "amount": 2500, "status": "Pending", "partialApprovalAllowed": false, "direction": "Debit", "atmName": "HOME FED SAV BK", "atmLocation": "Cupertino, CA, US", "surcharge": 0, "internationalServiceFee": 0, "cardNetwork": "Allpoint" }, "relationships": { "customer": { "data": { "type": "customer", "id": "10000" } }, "account": { "data": { "type": "account", "id": "10001" } }, "card": { "data": { "type": "card", "id": "7" } } }}
#
StatementStatement
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). |
#
AttributesField | type | Description |
---|---|---|
period | string | Period of the statement, formatted YYYY-MM , e.g "2020-05" . |
#
RelationshipsField | type | Description |
---|---|---|
account | JSON:API Relationship | The account for which the statement was produced. |
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. |
{ "type": "statement", "id": "1", "attributes": { "period": "2020-07" }, "relationships": { "account": { "data": { "type": "account", "id": "1000" } }, "customer": { "data": { "type": "customer", "id": "1" } } }}
#
BatchReleaseBatchRelease
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). |
#
AttributesName | 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. |
#
RelationshipsName | 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. |
{ "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" } } }}
#
FeeFee
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). |
#
AttributesName | Type | Description |
---|---|---|
amount | integer | The amount (in cents) of the fee. |
description | string | Description of the fee. |
tags | object | See Tags. |
#
RelationshipsName | Type | Description |
---|---|---|
account | JSON:API Relationship | The account the fee belongs to. |
{ "data": { "type": "fee", "id": "1234", "attributes": { "amount": 1000, "description": "Monthly Subscription" }, "relationships": { "account": { "data": { "type": "depositAccount", "id": "10097" } } } }}
#
ChargebackThis resource is generated as a result of a chargeback creation request.
Chargeback
is a JSON:API resource, top-level fields:
Field | type | Description |
---|---|---|
id | string | Identifier of the chargeback resource. |
type | string | Type of the chargeback resource. The value is always chargeback . |
attributes | JSON Object | JSON object representing the fee data. |
relationships | JSON:API Relationships | Describes relationships between the chargeback resource and other resources (accounts, transaction, customer). |
#
AttributesName | Type | Description |
---|---|---|
createdAt | RFC3339 Date string | The date the chargeback was created. |
amount | integer | The amount (in cents) of the chargeback. |
description | string | Description of the chargeback. |
tags | object | See Tags. |
#
RelationshipsName | Type | Description |
---|---|---|
account | JSON:API Relationship | The Deposit Account the funds will be debited from. |
customer | JSON:API Relationship | The Customer the deposit account belongs to. |
counterpartyAccount | JSON:API Relationship | The account that will receive the funds. |
transaction | JSON:API Relationship | The Chargeback Transaction generated by this chargeback. |
{ "type": "chargeback", "id": "2", "attributes": { "createdAt": "2022-03-24T17:36:47.638Z", "amount": 5000, "description": "Chargeback for dispute #1337", "tags": { "internalId": "abc1345" } }, "relationships": { "account": { "data": { "type": "account", "id": "10006" } }, "customer": { "data": { "type": "customer", "id": "10007" } }, "counterpartyAccount": { "data": { "type": "account", "id": "10005" } }, "transaction": { "data": { "type": "transaction", "id": "25" } } }}
#
RewardThis resource is generated as a result of a reward creation request.
Reward
is a JSON:API resource, top-level fields:
Field | type | Description |
---|---|---|
id | string | Identifier of the reward resource. |
type | string | Type of the reward resource. The value is always reward . |
attributes | JSON Object | JSON object representing the reward data. |
relationships | JSON:API Relationships | Describes relationships between the reward resource and other resources (accounts, transaction, customer). |
#
AttributesName | Type | Description |
---|---|---|
createdAt | RFC3339 Date string | The date the reward was created. |
amount | integer | The amount (in cents) of the reward. |
description | string | Description of the reward. |
status | string | Either Sent or Rejected (see rejectReason for details). |
rejectReason | string | Optional. More information about the status. |
tags | object | See Tags. |
#
RelationshipsName | Type | Description |
---|---|---|
receivingAccount | JSON:API Relationship | The account that received the funds. |
fundingAccount | JSON:API Relationship | The account that sent the funds. |
rewardedTransaction | JSON:API Relationship | Optional. The transaction that caused the reward. |
customer | JSON:API Relationship | The Customer the deposit account belongs to. |
transaction | JSON:API Relationship | The Reward Transaction generated by the reward. |
card | JSON:API Relationship | Optional. The card the belongs to the rewardedTransaction (if exists) |
{ "type": "reward", "id": "20", "attributes": { "createdAt": "2022-03-31T14:42:55.780Z", "status": "Sent", "amount": 4000, "description": "A sample reward", "tags": {} }, "relationships": { "receivingAccount": { "data": { "type": "account", "id": "10001" } }, "fundingAccount": { "data": { "type": "account", "id": "10000" } }, "rewardedTransaction": { "data": { "type": "transaction", "id": "7" } }, "customer": { "data": { "type": "customer", "id": "10000" } }, "transaction": { "data": { "type": "transaction", "id": "24" } } }}
#
EventEvent
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. |
{ "data": [ { "id": "230", "type": "transaction.created", "attributes": { "createdAt": "2021-03-15T07:49:09.089Z", "amount": 10000, "direction": "Credit", "summary": "Wire to Jane Smith" }, "relationships": { "account": { "data": { "id": "10005", "type": "account" } }, "transaction": { "data": { "id": "189", "type": "wireTransaction" } }, "customer": { "data": { "id": "10000", "type": "individualCustomer" } } } } ]}
#
WebhookWebhook
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. |
#
AttributesName | 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 . |
deliveryMode | string | The attempted delivery mode of the webhook. Either AtMostOnce or AtLeastOnce . |
token | string | The secret token (see Securing your webhooks). |
{ "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", "deliveryMode": "AtLeastOnce", "token": "MyToken" } }}
#
APITokenAPIToken
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. |
#
AttributesName | 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. |
{ "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..." } }}
#
Account End-Of-DayAccount 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). |
#
AttributesName | Type | Description |
---|---|---|
date | ISO Local Date string | The date the account end-of-day resource was created. |
balance | integer | The balance amount (in cents). The balance equals thee sum of 'available' and 'hold'. |
hold | integer | The hold amount (in cents). Not available for spending. |
available | integer | The available balance for spending (in cents). |
#
RelationshipsField | type | Description |
---|---|---|
account | JSON:API Relationship | The account the resource belongs to. |
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. |
{ "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" } } }}
#
PinStatusPinStatus
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. |
#
AttributesName | Type | Description |
---|---|---|
status | string | Status of the PIN, either Set or NotSet . |
{ "data": { "type": "pinStatus", "attributes": { "status": "NotSet" } }}
#
Check DepositCheckDeposit
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 |
#
AttributesName | 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. |
checkNumber | string | Optional. The serial number printed at the bottom of the check |
counterparty | Check Counterparty | Optional. The party the check belongs to. |
settlementDate | RFC3339 Date string | Optional, For Pending or Clearing , shows the date on which the check will be settled. |
tags | object | See Tags. |
#
RelationshipsName | Type | Description |
---|---|---|
account | JSON:API Relationship | The Deposit Account receiving the check deposit. |
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. |
transaction | JSON:API Relationship | The Check Deposit Transaction generated by this check deposit. |
{ "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" } } } }}
#
InstitutionInstitution
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. |
#
AttributesName | 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. |
{ "type": "institution", "attributes": { "routingNumber": "091311229", "name": "Choice Financial Group", "address": "Ste 300 Fargo ND 58104", "isACHSupported": true, "isWireSupported": false }}
#
ApplicationFormApplicationForm
is a JSON:API resource, top-level fields:
Field | type | Description |
---|---|---|
id | string | Identifier of the application form resource. |
type | string | Type of the application form resource. The value is always applicationForm . |
attributes | JSON Object | JSON object representing the application form data. |
relationships | JSON:API Relationships | Describes relationships between the application form resource and other resources |
#
AttributesField | 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 |
stage | string | Current stage of the application form, one of: ChooseBusinessOrIndividual , EnterIndividualInformation , IndividualPhoneVerification , IndividualApplicationCreated , EnterBusinessInformation , EnterOfficerInformation , BusinessPhoneVerification , EnterBeneficialOwnersInformation , BusinessApplicationCreated , EnterSoleProprietorshipInformation , SoleProprietorshipPhoneVerification , SoleProprietorshipApplicationCreated |
applicantDetails | ApplicationFormPrefill | Data that is already known about the end-customer to be auto populated on the form. |
settingsOverride | ApplicationFormSettingsOverride | Disclosure URLs that will override the ones that were defined in the application form settings. |
#
RelationshipsName | Type | Description |
---|---|---|
application | Optional, JSON:API Relationship | The Application resource that the application form has created. This relationship is only available if the application form has been completed by an end-customer and an application has been submitted. |
{ "data": { "type": "applicationForm", "id": "95", "attributes": { "tags": { "userId": "106a75e9-de77-4e25-9561-faffe59d7814" }, "url": "https://application-form.sh/6YZ3UG6RS7NGTO5ZB3A4SRO3NEYPJUREYIIKZDOOX2CTWBPZ4A343UB4KZSQRF3DHHKYECF4S45VP7Y2YUP5WGEHO4YVH25Q24JRM4UA5IW3OM552HAFJ3HIVIUJGJBFQ4UJMZ3VGXUG6L5XFKE2W7YX7KDOC2J", "stage": "IndividualApplicationCreated", "applicantDetails": { "applicationType": "Individual", "fullName": { "first": "Peter", "last": "Parker" }, "passport": "12345678", "nationality": "US", "dateOfBirth": "2001-08-10", "email": "peter@oscorp.com", "name": "Pied Piper", "stateOfIncorporation": "DE", "entityType": "Corporation", "address": { "street": "5230 Newell Rd", "city": "Palo Alto", "state": "CA", "postalCode": "94303", "country": "US" }, "phone": { "countryCode": "1", "number": "2025550187" } } }, "relationships": { "application": { "data": { "type": "application", "id": "10098" } } } }}
#
ATM LocationATM Location
is a JSON:API resource, top-level fields:
Field | type | Description |
---|---|---|
type | string | Type of the ATM location resource. The value is always atmLocation . |
attributes | JSON Object | JSON object representing the ATM location data. |
#
AttributesName | Type | Description |
---|---|---|
network | string | Name of the ATM network. |
locationName | string | Name of the ATM's location. |
coordinates | Coordinates | Coordinates (latitude, longitude) of the ATM. |
address | Address | Address of the ATM. |
distance | number | Distance to the ATM (in miles). |
surchargeFree | boolean | Indicates if the ATM is surcharge free. |
acceptDeposits | boolean | Indicates if the ATM accepts deposits. |
{ "type": "atmLocation", "attributes": { "network": "Allpoint", "locationName": "SPEEDWAY", "coordinates": { "longitude": -73.93041, "latitude": 42.79894 }, "address": { "street": "229 S BRANDYWINE AVE", "city": "SCHENECTADY", "state": "NY", "postalCode": "12307", "country": "US" }, "distance": 1.07, "surchargeFree": true, "acceptDeposits": false }}
#
BillerBiller
is a JSON:API resource, top-level fields:
Field | type | Description |
---|---|---|
id | string | Identifier of the biller resource. |
type | string | Type of the biller resource. The value is always biller . |
attributes | JSON Object | JSON object representing the biller data. |
#
AttributesField | Type | Description |
---|---|---|
name | string | Name of the biller. |
category | string | The category this biller is belong to. |
addresses | Array[Address] | Array of biller address |
{ "type": "biller", "id": "7b0fd858-5f86-4c5e-80fc-6feb6cba4186", "attributes": { "name": "Adams-Columbia Electric Cooperative", "category": "Electric / Gas / Power / Water" }}
#
MobileWalletPayloadMobileWalletPayload
is a JSON:API resource, top-level fields:
Field | type | Description |
---|---|---|
type | string | Type of the MobileWalletPayload resource. The value is always mobileWalletPayload . |
attributes | JSON Object | JSON object representing the MobileWalletPayload data. |
#
AttributesName | Type | Description |
---|---|---|
payload | string | Encrypted payload. |
{ "data":