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. |
idTheftScore | number | Optional. Score (0-1000) for ID theft verification, >900 is auto rejected as default (threshold is configurable). |
tags | object | See Tags. |
#
RelationshipsField | type | Description |
---|---|---|
documents | Array of JSON:API Relationship | Optional. 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 | Optional. The receiving party of the transaction. Available only when the receiving party is a Deposit Account. |
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" } } } }}
#
Account Low Balance Closure TransactionAn accountLowBalanceClosureTransaction
represents account low balance closure transaction.
AccountLowBalanceClosureTransaction
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 accountLowBalanceClosureTransaction . |
attributes | JSON Object | JSON object representing the transaction data. |
relationships | JSON:API Relationships | Describes relationships between the transaction resource and other resources (accounts, 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. |
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. |
receiverAccount | JSON:API Relationship | The Deposit Account receiver. |
{ "data": { "type": "accountLowBalanceClosureTransaction", "id": "53", "attributes": { "createdAt": "2022-04-06T10:46:34.371Z", "receiverCounterparty": { "name": "Unit Finance Inc.", "routingNumber": "091311229", "accountNumber": "864800000000", "accountType": "Checking" }, "amount": 800, "direction": "Credit", "balance": 113000, "summary": "Account Low Balance Closure", "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" } }, "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 LLC , Partnership , PubliclyTradedCorporation , PrivatelyHeldCorporation or NotForProfitOrganization . |
website | string | Optional. Business's website. |
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. |
annualRevenue | AnnualRevenue | Optional. Annual revenue of the business. |
numberOfEmployees | NumberOfEmployees | Optional. Number of employees of the business. |
cashFlow | CashFlow | Optional. Cash flow of the business. |
yearOfIncorporation | Year string | Year of incorporation of the business. |
countriesOfOperation | Array of ISO31661-Alpha2 strings | Optional. An array of two letter codes representing the countries of operation of the business. |
stockSymbol | string | Optional. The stock symbol (ticker) of the business. |
businessVertical | BusinessVertical | Optional. The business vertical of the business. |
ip | string | Optional. IP address of the end-customer creating the application. Both IPv4 and IPv6 formats are supported. Highly recommended as a fraud prevention measure, if the information is available when submitting the application. |
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 | Optional. 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" }, "occupation": "ArchitectOrEngineer", "annualIncome": "Between10kAnd25k", "sourceOfIncome": "EmploymentOrPayrollIncome", "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", "occupation": "ArchitectOrEngineer", "annualIncome": "Between10kAnd25k", "sourceOfIncome": "EmploymentOrPayrollIncome", "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 , EmployerIdentificationNumberConfirmation , SocialSecurityCard , ClientRequested or SelfieVerification . |
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 IdDocument 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. | |
occupation | Occupation | Optional. Occupation of the beneficial owner. |
annualIncome | AnnualIncome | Optional. Annual income of the beneficial owner. |
sourceOfIncome | SourceOfIncome | Optional. Source of income of the beneficial owner. |
{ "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", "occupation": "ArchitectOrEngineer", "annualIncome": "Between50kAnd100k", "sourceOfIncome": "EmploymentOrPayrollIncome" }}
#
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. |
ein | string | Optional. Indicates if the individual is a sole proprietor who has an Employer Identification Number, if specified. |
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 LLC , Partnership , PubliclyTradedCorporation , PrivatelyHeldCorporation or NotForProfitOrganization . |
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" } } }}
#
BusinessFBOCustomerBusinessFBOCustomer
is a JSON:API resource, describing the business fbo customer. Top-level fields:
Field | type | Description |
---|---|---|
id | string | Identifier of the business resource. |
type | string | Type of the resource, the value is always businessFBOCustomer . |
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. |
businessName | string | Name of the business. |
name | string | The offical name |
businessVertical | BusinessVertical | The business vertical of the business. |
bankName | string | the name of the bank. |
numberOfEmployees | NumberOfEmployees | Number of employees of the business. |
address | Address | Address of the business. |
tags | object | Optional. See Tags. |
#
RelationshipsName | Type | Description |
---|---|---|
org | JSON:API Relationship | The Org of the business. |
{ "type": "businessFBOCustomer", "id": "1", "attributes": { "createdAt": "2023-07-23T09:13:18.926Z", "businessName": "Pied Piper", "name": "Piermont for the benefit of Pied Piper", "businessVertical": "RepairAndMaintenance", "bankName": "Piermont", "numberOfEmployees": "Between10And50", "address": { "street": "1463 41st Avenue", "city": "San Francisco", "state": "CA", "postalCode": "94122", "country": "US" }, "tags": {} }, "relationships": { "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 , ByBank , or free-text description. |
closeReason | string | Optional. The reason the account was closed, either ByCustomer ,Fraud or ByBank . |
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 multiple owners. |
{ "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" } } }}
#
FinancialBusinessFBOAccountFinancialBusinessFBOAccount
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 financialBusinessFBOAccount . |
attributes | JSON Object | JSON object representing the financial business fbo account data. |
relationships | JSON:API Relationships | Describes relationships between the financial business fbo 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 | The offical name. |
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 , ByBank , 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 | JSON:API Relationship | The customer. |
{ "type": "financialBusinessFBOAccount", "id": "1", "attributes": { "createdAt": "2023-07-12T10:19:30.409Z", "name": "Blue Ridge for the benefit of Pied Piper Inc.", "status": "Open", "depositProduct": "checking", "routingNumber": "812345678", "accountNumber": "1000000002", "currency": "USD", "balance": 10000, "hold": 0, "available": 10000, "tags": { "purpose": "fbo" } }, "relationships": { "customer": { "data": { "type": "customer", "id": "8" } } }}
#
CreditAccountCreditAccount
is a JSON:API resource, top-level fields:
Field | type | Description |
---|---|---|
id | string | Identifier of the credit account resource. |
type | string | Type of the resource. Currently only creditAccount is supported. |
attributes | JSON Object | JSON object representing the credit account data. |
relationships | JSON:API Relationships | Describes relationships between the credit 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. |
creditTerms | string | The selected credit terms. |
currency | string | Currency of the account. |
creditLimit | integer | The credit limit (cents). |
balance | integer | The balance amount (cents). The balance represents the funds that are currently in the account (not taking into account future commitments). The balance equals the sum of settled transactions minus any repayments. |
hold | integer | The hold amount (cents). The hold represents funds that are not available for spending, due to an outstanding card authorization. |
available | integer | The available balance for spending (cents). Equals the credit limit, minus the balance and hold amounts. |
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 , ByBank , or free-text description. |
closeReason | string | Optional. The reason the account was closed, either ByCustomer , Overdue or Fraud . |
closeReasonText | string | Optional. An expanded free-text reason for account closure. |
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 ). |
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. |
{ "data": { "type": "creditAccount", "id": "42", "attributes": { "createdAt": "2000-05-11T10:19:30.409Z", "name": "Peter Parker", "status": "Open", "creditTerms": "credit_terms_1", "currency": "USD", "balance": 10000, "hold": 0, "available": 10000, "tags": { "purpose": "some_purpose" }, "creditLimit": 200000 }, "relationships": { "customer": { "data": { "type": "customer", "id": "45555" } }, "org": { "data": { "type": "org", "id": "1" } } } }}
#
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. |
bin | string | 9-digit Bank Identification Number (BIN). |
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", "bin": "123456789", "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. |
bin | string | 9-digit Bank Identification Number (BIN). |
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", "bin": "123456789", "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" . |
bin | string | 9-digit Bank Identification Number (BIN). |
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", "bin": "123456789", "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. |
bin | string | 9-digit Bank Identification Number (BIN). |
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", "bin": "123456789", "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 counterparty 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 , Savings or Loan . |
type | string | Either Business , Person or Unknown . |
permissions | string | Either CreditOnly or CreditAndDebit . |
tags | object | See Tags. |
#
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. |
counterpartyVerificationMethod | string | Optional, shows the verification method of the counterparty : 'Plaid'. |
sameDay | boolean | Indicates whether the payment is a Same Day ACH payment. See Same Day ACH. |
secCode | string | The 3-letter ACH Standard Entry Class (SEC) Code. One of WEB , CCD , PPD . |
clearingDaysOverride | integer | Optional, the amount of days it will take an Originated ACH debit to clear. See Dynamic Clearing Period. |
#
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, "sameDay": false, "secCode": "WEB" }, "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 80 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" } } } }}
#
Recurring Debit ACH PaymentRecurringDebitAchPayment
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 80 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": "recurringDebitAchPayment", "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 80 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 80 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" } } } }}
#
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 , PendingReview , MarkedForReturn , 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. |
isAdvanceable | boolean | Will be true if the received payment can be advanced. |
direction | string | The direction in which the funds flow (either Debit or Credit ). |
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 80 characters). |
companyName | string | The name by which the originator is known to the receiver. |
receivingEntityName | string | Optional. The name of the Recipient as it was declared by the originator of the payment. |
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" } } } }}
#
ACH RepaymentAchRepayment
is a JSON:API resource, top-level fields:
Field | type | Description |
---|---|---|
id | string | Identifier of the ACH repayment resource. |
type | string | Type of the payment resource. For ach repayment the value is achRepayment . |
attributes | JSON Object | JSON object representing the repayment resource. |
relationships | JSON:API Relationships | Describes relationships between the ACH repayment and the originating deposit account, credit 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. |
status | string | Either Pending, PendingReview, Returned, Sent or Rejected |
tags | object | See Tags. |
#
RelationshipsName | Type | Description |
---|---|---|
account | JSON:API Relationship | The Deposit Account originating the repayment. |
creditAccount | JSON:API Relationship | The Credit Account the repayment is made for. |
org | JSON:API Relationship | The org the customer belongs to. |
customer | Optional, JSON:API Relationship | The Customer the credit 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 repayment to be made from. |
payment | JSON:API Relationship | The payment created between the account and the counterparty |
{ "data": { "type": "achRepayment", "id": "1", "attributes": { "createdAt": "2022-09-19T09:02:13.343Z", "updatedAt": "2022-09-19T09:02:13.343Z", "amount": 200, "status": "Pending" }, "relationships": { "org": { "data": { "type": "org", "id": "1" } }, "account": { "data": { "type": "account", "id": "10003" } }, "counterparty": { "data": { "type": "counterparty", "id": "1" } }, "creditAccount": { "data": { "type": "creditAccount", "id": "10007" } }, "customer": { "data": { "type": "customer", "id": "10002" } }, "payment": { "data": { "type": "payment", "id": "1" } } } }}
#
Book RepaymentBookRepayment
is a JSON:API resource, top-level fields:
Field | type | Description |
---|---|---|
id | string | Identifier of the Book repayment resource. |
type | string | Type of the payment resource. For book repayment the value is bookRepayment . |
attributes | JSON Object | JSON object representing book repayment resource. |
relationships | JSON:API Relationships | Describes relationships between the book repayment and the originating deposit account, credit 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. |
status | string | Either Pending, PendingReview, Returned, Sent or Rejected |
tags | object | See Tags. |
#
RelationshipsName | Type | Description |
---|---|---|
account | JSON:API Relationship | The Deposit Account originating the repayment. |
creditAccount | JSON:API Relationship | The Credit Account the repayment is made for. |
org | JSON:API Relationship | The org the customer belongs to. |
customer | Optional, JSON:API Relationship | The Customer the credit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual. |
counterpartyAccount | JSON:API Relationship | The Deposit Account the repayment to be made from. |
payment | JSON:API Relationship | The payment created between the account and counterpartyAccount |
{ "data": { "type": "bookRepayment", "id": "5", "attributes": { "createdAt": "2022-09-19T09:33:16.254Z", "updatedAt": "2022-09-19T09:33:16.254Z", "amount": 20, "status": "Sent" }, "relationships": { "counterparty": { "data": { "type": "account", "id": "10008" } }, "account": { "data": { "type": "account", "id": "10006" } }, "creditAccount": { "data": { "type": "creditAccount", "id": "10007" } }, "customer": { "data": { "type": "customer", "id": "10002" } }, "org": { "data": { "type": "org", "id": "2" } }, "payment": { "data": { "type": "payment", "id": "6" } } } }}
#
Capital Partner ACH RepaymentcapitalPartnerAchRepayment
is a JSON:API resource, top-level fields:
Field | type | Description |
---|---|---|
id | string | Identifier of the Capital Partner repayment resource. |
type | string | Type of the payment resource. For capital partner ACH repayment the value is capitalPartnerAchRepayment . |
attributes | JSON Object | JSON object representing the repayment resource. |
relationships | JSON:API Relationships | Describes relationships between the capital partner ACH repayment and the credit account. |
#
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. |
status | string | Either Pending, PendingReview, Returned, Sent or Rejected |
tags | object | See Tags. |
#
RelationshipsName | Type | Description |
---|---|---|
creditAccount | JSON:API Relationship | The Credit Account the repayment is made for. |
counterparty | JSON:API Relationship | The Counterparty the repayment to be made from. |
org | JSON:API Relationship | The org the customer belongs to. |
customer | Optional, JSON:API Relationship | The Customer the credit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual. |
payment | JSON:API Relationship | The payment created between the capital partner's account and the counterparty |
{ "type": "capitalPartnerAchRepayment", "id": "1", "attributes": { "createdAt": "2022-09-19T09:02:13.343Z", "updatedAt": "2022-09-19T09:02:13.343Z", "amount": 200, "status": "Pending" }, "relationships": { "counterparty": { "data": { "type": "counterparty", "id": "1" } }, "creditAccount": { "data": { "type": "creditAccount", "id": "10007" } }, "org": { "data": { "type": "org", "id": "1" } }, "payment": { "data": { "type": "payment", "id": "1" } } }}
#
Capital Partner Book RepaymentcapitalPartnerBookRepayment
is a JSON:API resource, top-level fields:
Field | type | Description |
---|---|---|
id | string | Identifier of the Capital Partner repayment resource. |
type | string | Type of the payment resource. For capital partner book repayment the value is capitalPartnerBookRepayment . |
attributes | JSON Object | JSON object representing the repayment resource. |
relationships | JSON:API Relationships | Describes relationships between the capital partner book repayment and the credit account. |
#
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. |
status | string | Either Pending, PendingReview, Returned, Sent or Rejected |
tags | object | See Tags. |
#
RelationshipsName | Type | Description |
---|---|---|
creditAccount | JSON:API Relationship | The Credit Account the repayment is made for. |
counterpartyAccount | JSON:API Relationship | The Deposit Account the repayment to be made from. |
org | JSON:API Relationship | The org the customer belongs to. |
customer | Optional, JSON:API Relationship | The Customer the credit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual. |
payment | JSON:API Relationship | The payment created between the capital partner's account and the counterparty |
{ "type": "capitalPartnerBookRepayment", "id": "4", "attributes": { "createdAt": "2022-09-19T09:10:09.206Z", "updatedAt": "2022-09-19T09:10:09.206Z", "amount": 20, "status": "Sent" }, "relationships": { "counterparty": { "data": { "type": "account", "id": "10008" } }, "creditAccount": { "data": { "type": "creditAccount", "id": "10007" } }, "customer": { "data": { "type": "customer", "id": "10002" } }, "org": { "data": { "type": "org", "id": "1" } }, "payment": { "data": { "type": "payment", "id": "5" } } }}
#
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. |
secCode | string | The 3-letter ACH Standard Entry Class (SEC) Code. One of WEB , CCD , PPD . |
traceNumber | string | Optional. The 15-digit ACH Trace Number identifies the transaction within the ACH file after transmission. |
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" }, "secCode": "WEB", "traceNumber": "812345670000123" }, "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: Account has insufficient funds", "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" } } }}
#
Push To Card TransactionPushToCardTransaction
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 pushToCardTransaction . |
attributes | JSON Object | JSON object representing the transaction data. |
relationships | JSON:API Relationships | Describes relationships between the transaction resource and other resources. |
#
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. 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 | Optional, JSON:API Relationship | The payment belonging to this transaction. |
org | JSON:API Relationship | The org the customer belongs to. |
{ "data": { "type": "pushToCardTransaction", "id": "777", "attributes": { "createdAt": "2023-03-23T13:56:04.200Z", "amount": 501, "direction": "Debit", "balance": 10619, "summary": "My Unit Account to Card Routine #2", "tags": {} }, "relationships": { "account": { "data": { "type": "account", "id": "42" } }, "customer": { "data": { "type": "customer", "id": "28" } }, "customers": { "data": [ { "type": "customer", "id": "19" } ] }, "org": { "data": { "type": "org", "id": "1" } }, "payment": { "data": { "type": "payment", "id": "68" } } } }}
#
Push To Card Reversal TransactionPushToCardReversalTransaction
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 pushToCardReversalTransaction . |
attributes | JSON Object | JSON object representing the transaction data. |
relationships | JSON:API Relationships | Describes relationships between the transaction resource and other resources. |
#
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. 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 | Optional, JSON:API Relationship | The payment belonging to this transaction. |
org | JSON:API Relationship | The org the customer belongs to. |
originalTransaction | JSON:API Relationship | The original push to card transaction |
{ "data": { "type": "pushToCardReversalTransaction", "id": "7", "attributes": { "createdAt": "2023-05-22T08:04:43.692Z", "amount": 500005, "direction": "Credit", "balance": 1499947, "summary": "Push to card transaction reversal for original transaction #6 | My Unit Account to Card Routine #900-5", "tags": {} }, "relationships": { "account": { "data": { "type": "account", "id": "10003" } }, "customer": { "data": { "type": "customer", "id": "10003" } }, "customers": { "data": [ { "type": "customer", "id": "10003" } ] }, "org": { "data": { "type": "org", "id": "1" } }, "payment": { "data": { "type": "payment", "id": "1005" } }, "originalTransaction": { "data": { "type": "originalTransaction", "id": "6" } } } }}
#
Cash Deposit TransactionCashDepositTransaction
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 cashDepositTransaction . |
attributes | JSON Object | JSON object representing the transaction data. |
relationships | JSON:API Relationships | Describes relationships between the transaction resource and other resources. |
#
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. 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. |
{ "type": "cashDepositTransaction", "id": "1523", "attributes": { "createdAt": "2020-07-05T15:49:36.864Z", "direction": "Credit", "amount": 10000, "balance": 12000, "summary": "Cash deposit at Walgreens | Via card ending with 1234" }, "relationships": { "account": { "data": { "type": "depositAccount", "id": "1000" } }, "customer": { "data": { "type": "customer", "id": "3" } } }}
#
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. |
merchant.id | string | Optional. The unique network merchant identifier. |
coordinates | Coordinates | Optional. Coordinates (latitude, longitude) of where the purchase took place. |
recurring | boolean | Indicates whether the transaction is recurring. |
interchange | string | Optional. The interchange share for this transaction. Calculated at the end of each day, see the transaction.updated event. |
grossInterchange | string | Optional. The gross interchange share for this transaction. |
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). |
cashWithdrawalAmount | integer | Optional. Cash withdrawal amount |
richMerchantData | Rich Merchant Data | Optional. Full merchant information. |
currencyConversion | Currency Conversion | Optional. When original currency for transaction is not USD. |
#
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", "id": "029859000085093" }, "coordinates": { "longitude": -77.0364, "latitude": 38.8951 }, "recurring": false, "interchange": "2.43", "grossInterchange": "200.00", "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 | string | Optional. The interchange share for this transaction. Calculated at the end of each day, see the transaction.updated event. |
grossInterchange | string | Optional. The gross interchange share for this transaction. |
cardNetwork | string | Optional. The card network used, one of: Visa , Interlink , Accel , Allpoint , Other . |
tags | object | See Tags. |
currencyConversion | Currency Conversion | Optional. When original currency for transaction is not USD. |
### Relationships
Field | 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", "grossInterchange": "200.00" }, "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" } } }}
#
Negative Balance Coverage TransactionnegativeBalanceCoverageTransaction
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 negativeBalanceCoverageTransaction . |
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. |
{ "type": "negativeBalanceCoverageTransaction", "id": "97", "attributes": { "createdAt": "2022-07-18T13:56:05.385Z", "amount": 2005, "direction": "Credit", "balance": 0, "summary": "Negative balance coverage of account 10014" }, "relationships": { "account": { "data": { "type": "account", "id": "10014" } }, "customer": { "data": { "type": "customer", "id": "10009" } }, "customers": { "data": [ { "type": "customer", "id": "10009" } ] } }}
#
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. |
card | JSON:API Relationship | The debit card used in the purchase. |
{ "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": { "data": { "type": "card", "id": "11" } } }}
#
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. |
merchant.id | string | Optional. The unique network merchant identifier. |
recurring | boolean | Optional. Indicates whether the transaction is recurring. |
interchange | string | Optional. The interchange share for this transaction. Calculated at the end of each day, see the transaction.updated event. |
grossInterchange | string | Optional. The gross interchange share for this transaction. |
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 . |
richMerchantData | Rich Merchant Data | Optional. Full merchant information. |
tags | object | See Tags. |
currencyConversion | Currency Conversion | Optional. When original currency for transaction is not USD. |
#
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. |
authorization | JSON:API Relationship | Optional. The Authorization request made, if present (see Authorizations). |
card | JSON:API Relationship | The debit card used in the purchase. |
{ "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", "id": "029859000085093" }, "recurring": false, "interchange": "2.43", "grossInterchange": "200.00", "paymentMethod": "Contactless", "digitalWallet": "Apple", "cardVerificationData": { "verificationMethod": "CVV2" }, "cardNetwork": "Visa" }, "relationships": { "account": { "data": { "type": "account", "id": "10001" } }, "customer": { "data": { "type": "customer", "id": "1001" } }, "card": { "data": { "type": "card", "id": "11" } } }}
#
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 | Optional. 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" } } }}
#
Interest Share TransactioninterestShareTransaction
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 interestShareTransaction . |
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 org). |
#
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. |
org | JSON:API Relationship | The Org of the customer. |
{ "data": { "type": "interestShareTransaction", "id": "12345", "attributes": { "createdAt": "2021-09-01T04:08:33.250Z", "amount": 1, "direction": "Credit", "balance": 7, "summary": "Interest Share August 2021" }, "relationships": { "account": { "data": { "type": "account", "id": "1" } }, "customer": { "data": { "type": "customer", "id": "24" } }, "customers": { "data": [ { "type": "customer", "id": "24" } ] }, "org": { "data": { "type": "org", "id": "1" } } } }}
#
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" } } } }}
#
Check Payment TransactionCheckPaymentTransaction
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 checkPaymentTransaction . |
attributes | JSON Object | JSON object representing the transaction data. |
relationships | JSON:API Relationships | Describes relationships between the transaction resource and other resources (account, customer, checkPayment). |
#
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. |
checkPayment | JSON:API Relationship | The Check Payment the transaction is related to. |
{ "type": "checkPaymentTransaction", "id": "7", "attributes": { "createdAt": "2023-02-21T11:40:55.442Z", "amount": 299991, "direction": "Debit", "balance": -1, "summary": "Check Payment | 0322" }, "relationships": { "account": { "data": { "type": "account", "id": "10002" } }, "customer": { "data": { "type": "customer", "id": "10005" } }, "customers": { "data": [ { "type": "customer", "id": "10005" } ] }, "checkPayment": { "data": { "type": "checkPayment", "id": "5" } } }}
#
Returned Check Payment TransactionReturnedCheckPaymentTransaction
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 returnedCheckPaymentTransaction . |
attributes | JSON Object | JSON object representing the transaction data. |
relationships | JSON:API Relationships | Describes relationships between the transaction resource and other resources (account, customer, checkPayment). |
#
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. |
returnReason | string | The reason for the transaction return. This is a replacement to the deprecated reason attribute. |
tags | object | See Tags. |
note
Currently, bot reason
and returnReason
are supported. Be advised that the values they return are different and that returnReason
will soon be deprecated, and reason
will be used to return the check payment return reasons as specified in the return reasons list.
#
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. |
checkPayment | JSON:API Relationship | The Check Payment the transaction is related to. |
{ "type": "returnedCheckPaymentTransaction", "id": "8", "attributes": { "createdAt": "2023-02-21T11:40:55.442Z", "amount": 299991, "direction": "Credit", "balance": 299990, "summary": "Returned Check Payment transaction #7 due to: Stop Payment", "returnReason": "StopPayment" }, "relationships": { "account": { "data": { "type": "account", "id": "10002" } }, "customer": { "data": { "type": "customer", "id": "10005" } }, "customers": { "data": [ { "type": "customer", "id": "10005" } ] }, "checkPayment": { "data": { "type": "checkPayment", "id": "5" } }, "returned": { "data": { "type": "transaction", "id": "7" } } }}
#
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 |