Skip to main content

Resources

IndividualApplication#

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

FieldtypeDescription
idstringIdentifier of the application resource.
typestringType of the application resource. For individual application the value is always individualApplication.
attributesJSON ObjectJSON object representing the application data.
relationshipsJSON:API RelationshipsDescribes relationships between the application resource and other resources (documents).

Attributes#

FieldtypeDescription
statusstringOne of AwaitingDocuments, PendingReview, Approved, Denied or Pending, see Application Statuses.
messagestringA message describing the IndividualApplication status.
createdAtRFC3339 Date stringThe date the resource was created.
ssnstringSSN of the individual (numbers only). Either ssn or passport will be populated.
passportstringIndividual passport number. Either ssn or passport will be populated.
nationalityISO31661-Alpha2 stringOnly when Passport is populated. Two letters representing the individual nationality (e.g. "US").
fullNameFullNameFull name of the individual.
dateOfBirthRFC3339 Date stringDate only (e.g. "2001-08-15").
addressAddressAddress of the individual.
phonePhonePhone of the individual.
emailstringEmail address of the individual.
ipstringIP address of the end-customer creating the application, if specified.
soleProprietorshipbooleanOptional. Indicates whether the individual is a sole proprietor, if specified.
einstringOptional. Indicates if the individual is a sole proprietor who has an Employer Identification Number, if specified.
dbastringOptional. Indicates if the individual is a sole proprietor who is doing business under a different name, if specified.
tagsobjectSee Tags.

Relationships#

FieldtypeDescription
documentsArray of JSON:API RelationshipApplication's documents.
customerJSON:API RelationshipOptional. The created Customer in case of approved application.
applicationFormJSON:API RelationshipOptional. The ApplicationForm through which the application has been submitted.
Example IndividualApplication resource:
{  "type": "individualApplication",  "id": "53",  "attributes": {    "createdAt": "2020-01-14T14:05:04.718Z",    "fullName": {      "first": "Peter",      "last": "Parker"    },    "ssn": "721074426",    "address": {      "street": "20 Ingram St",      "street2": null,      "city": "Forest Hills",      "state": "NY",      "postalCode": "11375",      "country": "US"    },    "dateOfBirth": "2001-08-10",    "email": "peter@oscorp.com",    "phone": {      "countryCode": "1",      "number": "1555555578"    },    "status": "AwaitingDocuments",    "message": "Waiting for you to upload the required documents.",    "tags": {      "userId": "106a75e9-de77-4e25-9561-faffe59d7814"    }  },  "relationships": {    "org": {      "data": {        "type": "org",        "id": "1"      }    },    "documents": {      "data": [        {          "type": "document",          "id": "1"        },        {          "type": "document",          "id": "2"        }      ]    },    "applicationForm": {      "data": {        "type": "applicationForm",        "id": "3"      }    }  }}

BusinessApplication#

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

FieldtypeDescription
idstringIdentifier of the application resource.
typestringType of the application resource, for business application the value is always businessApplication.
attributesJSON ObjectJSON object representing the application data.
relationshipsJSON:API RelationshipsDescribes relationships between the application resource and other resources (documents).

Attributes#

FieldtypeDescription
statusstringOne of AwaitingDocuments, PendingReview, Approved, Denied or Pending, see Application Statuses.
messagestringA message describing the BusinessApplication status.
createdAtRFC3339 Date stringThe date the resource was created.
namestringName of the business.
dbastringOptional. "Doing business as".
addressAddressAddress of the business.
phonePhonePhone of the business.
stateOfIncorporationstringTwo letters representing a US state.
einstringBusiness EIN (numbers only).
entityTypestringOne of "Corporation", "LLC" or "Partnership".
contactBusinessContactPrimary contact of the business.
officerOfficerOfficer representing the business, must be CEO, CFO, President or BenefitsAdministrationOfficer. The officer would need to go over KYC process and provide documents.
beneficialOwnersArray of BeneficialOwnerArray 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.
tagsobjectSee Tags.

Relationships#

FieldtypeDescription
documentsArray of JSON:API RelationshipApplication's documents.
customerJSON:API RelationshipOptional. The created Customer in case of approved application.
applicationFormJSON:API RelationshipOptional. The ApplicationForm through which the application has been submitted.
Example BusinessApplication resource:
{  "type": "businessApplication",  "id": "50",  "attributes": {    "createdAt": "2020-01-13T16:01:19.346Z",    "name": "Pied Piper",    "dba": null,    "address": {      "street": "5230 Newell Rd",      "street2": null,      "city": "Palo Alto",      "state": "CA",      "postalCode": "94303",      "country": "US"    },    "phone": {      "countryCode": "1",      "number": "1555555578"    },    "stateOfIncorporation": "DE",    "ein": "123456789",    "entityType": "Corporation",    "contact": {      "fullName": {        "first": "Richard",        "last": "Hendricks"      },      "email": "richard@piedpiper.com",      "phone": {        "countryCode": "1",        "number": "1555555578"      }    },    "officer": {      "fullName": {        "first": "Richard",        "last": "Hendricks"      },      "ssn": "123456789",      "address": {        "street": "5230 Newell Rd",        "street2": null,        "city": "Palo Alto",        "state": "CA",        "postalCode": "94303",        "country": "US"      },      "dateOfBirth": "2001-08-10",      "email": "richard@piedpiper.com",      "phone": {        "countryCode": "1",        "number": "1555555589"      },      "status": "Approved"    },    "beneficialOwners": [      {        "fullName": {          "first": "Richard",          "last": "Hendricks"        },        "ssn": "123456789",        "address": {          "street": "5230 Newell Rd",          "street2": null,          "city": "Palo Alto",          "state": "CA",          "postalCode": "94303",          "country": "US"        },        "dateOfBirth": "2001-08-10",        "phone": {          "countryCode": "1",          "number": "1555555589"        },        "email": "richard@piedpiper.com",        "status": "Approved"      }    ],    "tags": {      "userId": "106a75e9-de77-4e25-9561-faffe59d7814"    },    "status": "AwaitingDocuments",    "message": "Waiting for you to upload the required documents."  },  "relationships": {    "org": {      "data": {        "type": "org",        "id": "1"      }    },    "documents": {      "data": [        {          "type": "document",          "id": "1"        },        {          "type": "document",          "id": "2"        },        {          "type": "document",          "id": "3"        }      ]    },    "applicationForm": {      "data": {        "type": "applicationForm",        "id": "3"      }    }  }}

ApplicationDocument#

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

FieldtypeDescription
idstringIdentifier of the document resource.
typestringAlways document.
attributesJSON ObjectJSON object representing the document’s data.

Attributes#

FieldtypeDescription
statusstringOne of Required, ReceivedBack, ReceivedFront, Invalid, Approved or PendingReview, see Application Document Status.
documentTypestringOne of IdDocument, Passport, AddressVerification, CertificateOfIncorporation or EmployerIdentificationNumberConfirmation.
descriptionstringThe document requirements description.
namestringName of business or individual.
addressAddressIndividual address, present only for the AddressVerification document type.
dateOfBirthRFC3339 Date stringDate only (e.g. "2001-08-15"). Present only for Passport and License document types.
passportstringIndividual passport number. Present only for the Passport document type.
einstringBusiness EIN. Present only for the EmployerIdentificationNumberConfirmation document type.
reasonCodestringApplication Document rejection reason code. Present only when document status is Invalid. One of PoorQuality, NameMismatch, SSNMismatch, AddressMismatch, DOBMismatch, ExpiredId, EINMismatch, StateMismatch, Other.
reasonstringApplication Document rejection reason. Present only when document status is Invalid.
Example ApplicationDocument resource:
{  "type": "document",  "id": "3",  "attributes": {    "documentType": "IdDocument",    "status": "Approved",    "description": "Please provide a copy of your unexpired government issued photo ID which would include Drivers License or State ID.",    "name": "Richard Hendricks",    "dateOfBirth": "2001-08-15"  }}

IndividualCustomer#

IndividualCustomer is a JSON:API resource, describing the individual customer. Top-level fields:

FieldtypeDescription
idstringIdentifier of the individual resource.
typestringType of the resource, the value is always individualCustomer.
attributesJSON ObjectJSON object representing the individual data.
relationshipsJSON:API RelationshipsDescribes relationships between the customer resource, the Org it belongs to, and the Application it was created by.
FieldtypeDescription
createdAtRFC3339 Date stringThe date the resource was created.
ssnstringIndividual passport number. Either ssn or passport will be populated.
passportstringIndividual passport number. Either ssn or passport will be populated.
nationalityISO31661-Alpha2 stringOnly when Passport is populated. Two letters representing the individual nationality (e.g. "US").
fullNameFullNameFull name of the individual.
dateOfBirthRFC3339 Date stringDate only (e.g. "2001-08-15").
addressAddressAddress of the individual.
phonePhonePhone of the individual.
emailstringEmail address of the individual.
tagsobjectSee Tags.

Relationships#

NameTypeDescription
orgJSON:API RelationshipThe Org of the individual.
applicationJSON:API RelationshipThe Application that created this individual.
Example IndividualCustomer resource:
{  "type": "individualCustomer",  "id": "8",  "attributes": {    "createdAt": "2020-05-12T19:41:04.123Z",    "fullName": {      "first": "Peter",      "last": "Parker"    },    "ssn": "721074426",    "address": {      "street": "20 Ingram St",      "street2": null,      "city": "Forest Hills",      "state": "NY",      "postalCode": "11375",      "country": "US"    },    "dateOfBirth": "2001-08-10",    "email": "peter@oscorp.com",    "phone": {      "countryCode": "1",      "number": "1555555578"    },    "tags": {      "userId": "106a75e9-de77-4e25-9561-faffe59d7814"    }  },  "relationships": {    "org": {      "data": {        "type": "org",        "id": "1"      }    },    "application": {      "data": {        "type": "individualApplication",        "id": "8"      }    }  }}

BusinessCustomer#

BusinessCustomer is a JSON:API resource, describing the business customer. Top-level fields:

FieldtypeDescription
idstringIdentifier of the business resource.
typestringType of the resource, the value is always businessCustomer.
attributesJSON ObjectJSON object representing the business data.
relationshipsJSON:API RelationshipsDescribes relationships between the customer resource, the Org it belongs to, and the Application it was created by.

Attributes#

FieldtypeDescription
createdAtRFC3339 Date stringThe date the resource was created.
namestringName of the business.
dbastringOptional. "Doing business as".
addressAddressAddress of the business.
phonePhonePhone of the business.
stateOfIncorporationstringTwo letters representing a US state.
einstringBusiness EIN (numbers only).
entityTypestringOne of "Corporation" or "LLC".
contactBusinessContactPrimary contact of the business.
authorizedUsersArray of AuthorizedUserArray of authorized users. An authorized user is someone who can participate in the One Time Password (OTP) authentication process.
tagsobjectSee Tags. Inherited from the application tags (see Tag Inheritance).

Relationships#

NameTypeDescription
orgJSON:API RelationshipThe Org of the business.
applicationJSON:API RelationshipThe Application that created this business.
Example BusinessCustomer resource:
{  "type": "businessCustomer",  "id": "1",  "attributes": {    "createdAt": "2020-05-10T12:28:37.698Z",    "name": "Pied Piper",    "address": {      "street": "5230 Newell Rd",      "street2": null,      "city": "Palo Alto",      "state": "CA",      "postalCode": "94303",      "country": "US"    },    "phone": {      "countryCode": "1",      "number": "1555555578"    },    "stateOfIncorporation": "DE",    "ein": "123456789",    "entityType": "Corporation",    "contact": {      "fullName": {        "first": "Richard",        "last": "Hendricks"      },      "email": "richard@piedpiper.com",      "phone": {        "countryCode": "1",        "number": "1555555578"      }    },    "authorizedUsers": [      {        "fullName": {          "first": "Jared",          "last": "Dunn"        },        "email": "jared@piedpiper.com",        "phone": {          "countryCode": "1",          "number": "1555555590"        }      }    ],    "tags": {      "userId": "106a75e9-de77-4e25-9561-faffe59d7814"    }  },  "relationships": {    "org": {      "data": {        "type": "org",        "id": "1"      }    },    "application": {      "data": {        "type": "businessApplication",        "id": "1"      }    }  }}

DepositAccount#

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

FieldtypeDescription
idstringIdentifier of the deposit account resource.
typestringType of the resource, the value is always depositAccount.
attributesJSON ObjectJSON object representing the deposit account data.
relationshipsJSON:API RelationshipsDescribes relationships between the deposit account resource and the customer.

Attributes#

NameTypeDescription
createdAtRFC3339 Date stringThe date the resource was created.
namestringName of the account holder.
depositProductstringThe name of the deposit product.
routingNumberstringRouting number of account.
accountNumberstringAccount number, together with the routingNumber forms the identifier of the account on the ACH network.
currencystringCurrency of the account.
balanceintegerThe balance amount (in cents).
holdintegerThe hold amount (in cents).
availableintegerThe available balance for spending (in cents).
tagsobjectSee Tags.
statusstringStatus of the account, either Open or Closed.
closeReasonstringOptional. The reason the account was closed. either ByCustomer or Fraud.

Note: the currency is currently always set to USD. The balance is represented in cents.

Relationships#

NameTypeDescription
customerOptional, populated if account has a single owner. JSON:API RelationshipThe customer.
customersOptional, populated if account has
owners. Array of JSON:API RelationshipList of customers.
Example DepositAccount Resource:
{  "type": "depositAccount",  "id": "1",  "attributes": {    "createdAt": "2000-05-11T10:19:30.409Z",    "name": "Peter Parker",    "status": "Open",    "depositProduct": "checking",    "routingNumber": "812345678",    "accountNumber": "1000000002",    "currency": "USD",    "balance": 10000,    "hold": 0,    "available": 10000,    "tags": {      "purpose": "checking"    }  },  "relationships": {    "customer": {      "data": {        "type": "customer",        "id": "45555"      }    }  }}

IndividualDebitCard#

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

FieldtypeDescription
idstringIdentifier of the card resource.
typestringType of the card resource. For individual debit card the value is always individualDebitCard.
attributesJSON ObjectJSON object representing the card data.
relationshipsJSON:API RelationshipsDescribes relationships between the card resource and other resources (account and customer).

Attributes#

FieldtypeDescription
createdAtRFC3339 Date stringThe date the resource was created.
last4DigitsstringLast 4 digits of the debit card.
expirationDatestringCard expiration date, formatted YYYY-MM, e.g "2020-05".
shippingAddressAddressOptional. Shipping address, if specified.
statusstringStatus of the card, one of: Active, Inactive, Stolen, Lost, Frozen, ClosedByCustomer, SuspectedFraud.
designstringOptional. Card design, if specified.

Relationships#

FieldtypeDescription
accountJSON:API RelationshipThe account the card belongs to.
customerJSON:API RelationshipThe individual or business customer the card belongs to.
Example IndividualDebitCard resource:
{  "type": "individualDebitCard",  "id": "8",  "attributes": {    "createdAt": "2020-05-13T09:07:47.645Z",    "last4Digits": "1234",    "expirationDate": "2022-05",    "shippingAddress": {      "street": "5230 Newell Rd",      "street2": null,      "city": "Palo Alto",      "state": "CA",      "postalCode": "94303",      "country": "US"    },    "status": "Active"  },  "relationships": {    "account": {      "data": {        "type": "depositAccount",        "id": "2"      }    },    "customer": {      "data": {        "type": "individualCustomer",        "id": "2"      }    }  }}

BusinessDebitCard#

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

FieldtypeDescription
idstringIdentifier of the card resource.
typestringType of the card resource. For business debit card the value is always BusinessDebitCard.
attributesJSON ObjectJSON object representing the card data.
relationshipsJSON:API RelationshipsDescribes relationships between the card resource and other resources (account and customer).

Attributes#

FieldtypeDescription
createdAtRFC3339 Date stringThe date the resource was created.
last4DigitsstringLast 4 digits of the debit card.
expirationDatestringCard expiration date, formatted YYYY-MM, e.g "2020-05".
shippingAddressAddressOptional. Shipping address, if specified.
ssnstringSSN of the card holder (numbers only). Either an SSN or a passport number is required.
passportstringPassport number of the card holder. Either an SSN or a passport is required.
nationalityISO31661-Alpha2 stringOnly when Passport is populated. Two letters representing the card holder nationality. (e.g. "US").
fullNameFullNameFull name of the card holder.
dateOfBirthRFC3339 Date stringDate of birth of the card holder (e.g. "2001-08-15").
addressAddressAddress of the card holder.
phonePhonePhone of the card holder.
emailstringEmail address of the card holder.
statusstringStatus of the card, one of: Active, Inactive, Stolen, Lost, Frozen, ClosedByCustomer, SuspectedFraud.
designstringOptional. Card design, if specified.

Relationships#

FieldtypeDescription
accountJSON:API RelationshipAccount the card belong to.
customerJSON:API RelationshipHolder of the account.
Example BusinessDebitCard resource:
{  "type": "businessDebitCard",  "id": "9",  "attributes": {    "createdAt": "2020-05-13T09:42:21.857Z",    "last4Digits": "2074",    "expirationDate": "2022-05",    "shippingAddress": {      "street": "5230 Newell Rd",      "street2": null,      "city": "Palo Alto",      "state": "CA",      "postalCode": "94303",      "country": "US"    },    "address": {      "street": "5230 Newell Rd",      "street2": null,      "city": "Palo Alto",      "state": "CA",      "postalCode": "94303",      "country": "US"    },    "fullName": {      "first": "Richard",      "last": "Hendricks"    },    "phone": {      "countryCode": "1",      "number": "1555555578"    },    "email": "richard@piedpiper.com",    "dateOfBirth": "2001-08-10",    "ssn": "123456789",    "status": "Active"  },  "relationships": {    "account": {      "data": {        "type": "depositAccount",        "id": "1"      }    },    "customer": {      "data": {        "type": "businessCustomer",        "id": "1"      }    }  }}

IndividualVirtualDebitCard#

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

FieldtypeDescription
idstringIdentifier of the card resource.
typestringType of the card resource. For individual virtual debit card the value is always individualVirtualDebitCard.
attributesJSON ObjectJSON object representing the card data.
relationshipsJSON:API RelationshipsDescribes relationships between the card resource and other resources (account and customer).

Attributes#

FieldtypeDescription
createdAtRFC3339 Date stringThe date the resource was created.
last4DigitsstringLast 4 digits of the debit card.
expirationDatestringCard expiration date, formatted YYYY-MM, e.g "2020-05".
statusstringStatus of the card, one of: Active, Inactive, Stolen, Lost, Frozen, ClosedByCustomer, SuspectedFraud.

Relationships#

FieldtypeDescription
accountJSON:API RelationshipThe account the card belongs to.
customerJSON:API RelationshipThe individual or business customer the card belongs to.
Example IndividualVirtualDebitCard resource:
{  "type": "individualVirtualDebitCard",  "id": "8",  "attributes": {    "createdAt": "2020-05-13T09:07:47.645Z",    "last4Digits": "1234",    "expirationDate": "2022-05",    "status": "Active"  },  "relationships": {    "account": {      "data": {        "type": "depositAccount",        "id": "2"      }    },    "customer": {      "data": {        "type": "individualCustomer",        "id": "2"      }    }  }}

BusinessVirtualDebitCard#

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

FieldtypeDescription
idstringIdentifier of the card resource.
typestringType of the card resource. For business virtual debit card the value is always businessVirtualDebitCard.
attributesJSON ObjectJSON object representing the card data.
relationshipsJSON:API RelationshipsDescribes relationships between the card resource and other resources (account and customer).

Attributes#

FieldtypeDescription
createdAtRFC3339 Date stringThe date the resource was created.
last4DigitsstringLast 4 digits of the debit card.
expirationDatestringCard expiration date, formatted YYYY-MM, e.g "2020-05".
ssnstringSSN of the card holder (numbers only). Either an SSN or a passport number is required.
passportstringPassport number of the card holder. Either an SSN or a passport is required.
nationalityISO31661-Alpha2 stringOnly when Passport is populated. Two letters representing the card holder nationality. (e.g. "US").
fullNameFullNameFull name of the card holder.
dateOfBirthRFC3339 Date stringDate of birth of the card holder (e.g. "2001-08-15").
addressAddressAddress of the card holder.
phonePhonePhone of the card holder.
emailstringEmail address of the card holder.
statusstringStatus of the card, one of: Active, Inactive, Stolen, Lost, Frozen, ClosedByCustomer, SuspectedFraud.

Relationships#

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

ACH Counterparty#

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

FieldtypeDescription
idstringIdentifier of the ACH counterparty resource.
typestringType of the ACH counterparty resource.
attributesJSON ObjectJSON object representing the payment resource.
relationshipsJSON:API RelationshipsDescribes relationships between the ACH counterparty and the originating customer.

Attributes#

NameTypeDescription
createdAtRFC3339 Date stringThe date the resource was created.
namestringThe account holder's name (whether an individual or a business).
routingNumberstringValid 9-digit ABA routing transit number.
bankstringName of the bank.
accountNumberstringBank account number.
accountTypestringEither Checking or Savings.
typestringEither Business, Person or Unknown.
permissionsstringEither CreditOnly or CreditAndDebit.

Relationships#

NameTypeDescription
customerJSON:API RelationshipThe customer the counterparty belongs to.
Example Payment resource:
{  "type": "achCounterparty",  "id": "8",  "attributes": {    "createdAt": "2020-05-13T09:07:47.645Z",    "name": "Joe Doe",    "routingNumber": "011000138",    "bank": "Bank Of America",    "accountNumber": "123",    "accountType": "Checking",    "type": "Person",    "permissions": "CreditOnly"  },  "relationships": {    "customer": {      "data": {        "type": "customer",        "id": "111111"      }    }  }}

ACH Payment#

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

FieldtypeDescription
idstringIdentifier of the ACH payment resource.
typestringType of the payment resource. For originations the value is achPayment.
attributesJSON ObjectJSON object representing the payment resource.
relationshipsJSON:API RelationshipsDescribes relationships between the ACH payment and the originating deposit account and customer.

Attributes#

NameTypeDescription
createdAtRFC3339 Date stringThe date the resource was created.
statusstringOne of Pending, Rejected, Clearing, Sent, Canceled, Returned. See ACH Status.
reasonstring(Optional) More information about the status.
counterpartyCounterpartyThe party on the other side of the ACH payment.
directionstringThe direction in which the funds flow (either Debit or Credit).
descriptionstringPayment description (maximum of 10 characters), also known as Company Entry Description, this will show up on statement of the counterparty.
addendastringOptional, additional payment description (maximum of 50 characters), not all institutions present that.
amountstringThe amount (cents) of the payment.
settlementDateRFC3339 Date stringOptional, For Clearing, shows the date on which the payment will be settled.
tagsobjectSee Tags.

Relationships#

NameTypeDescription
accountJSON:API RelationshipThe Deposit Account originating the transfer.
customerOptionalJSON:API RelationshipThe Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customersOptional, Array of JSON:API RelationshipThe list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
counterpartyJSON:API RelationshipThe Counterparty the payment to be made to.
Example AchPayment resource:
{  "data": {    "type": "achPayment",    "id": "50",    "attributes": {      "createdAt": "2020-01-13T16:01:19.346Z",      "status": "Pending",      "counterparty": {        "routingNumber": "812345678",        "accountNumber": "12345569",        "accountType": "Checking",        "name": "Jane Doe"      },      "description": "Funding",      "direction": "Credit",      "amount": 10000    },    "relationships": {      "account": {        "data": {          "type": "depositAccount",          "id": "555"        }      },      "customer": {        "data": {          "type": "individualCustomer",          "id": "99823"        }      },      "counterparty": {        "data": {          "type": "counterparty",          "id": "4567"        }      },      "transaction": {        "data": {          "type": "transaction",          "id": "4003"        }      }    }  }}

Book Payment#

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

FieldtypeDescription
idstringIdentifier of the book payment resource.
typestringType of the payment resource. The value is always bookPayment.
attributesJSON ObjectJSON object representing the payment resource.
relationshipsJSON:API RelationshipsDescribes relationships between the ACH payment and the originating deposit account and customer.

Attributes#

NameTypeDescription
createdAtRFC3339 Date stringThe date the resource was created.
statusstringEither Sent or Rejected (see reason for details).
reasonstring(Optional) More information about the status.
directionstringThe direction in which the funds flow (either Debit or Credit).
descriptionstringPayment description (maximum of 50 characters), this will show up on statement of the counterparty.
amountstringThe amount (cents) of the payment.
tagsobjectSee Tags.

Relationships#

NameTypeDescription
accountJSON:API RelationshipThe Deposit Account creating the payment.
customerOptional, JSON:API RelationshipThe Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customersOptional, Array of JSON:API RelationshipThe list of Customers the deposit account belongs to. This relationship is only available if the account belongs to a multiple individual customers.
counterpartyAccountJSON:API RelationshipThe Counterparty account the payment to be made to.
counterpartyCustomerJSON:API RelationshipThe 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.
transactionJSON:API RelationshipThe Book Transaction generated by this payment.
Example BookPayment resource:
{  "data": {    "type": "bookPayment",    "id": "1232",    "attributes": {      "createdAt": "2021-02-21T13:03:19.025Z",      "amount": 1500,      "direction": "Credit",      "description": "Funding",      "status": "Sent"    },    "relationships": {      "account": {        "data": {          "type": "account",          "id": "555"        }      },      "customer": {        "data": {          "type": "customer",          "id": "10000"        }      },      "counterpartyAccount": {        "data": {          "type": "account",          "id": "99821"        }      },      "counterpartyCustomer": {        "data": {          "type": "customer",          "id": "10000"        }      },      "transaction": {        "data": {          "type": "transaction",          "id": "1413"        }      }    }  }}

Wire Payment#

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

FieldtypeDescription
idstringIdentifier of the wire payment resource.
typestringType of the payment resource. The value is always wirePayment.
attributesJSON ObjectJSON object representing the payment resource.
relationshipsJSON:API RelationshipsDescribes relationships between the Wire payment and the originating deposit account, customer and transaction.

Attributes#

NameTypeDescription
createdAtRFC3339 Date stringThe date the resource was created.
statusstringEither Pending or Sent or Rejected (see reason for details).
reasonstring(Optional) More information about the status.
directionstringThe direction in which the funds flow (Credit only).
descriptionstringPayment description (maximum of 50 characters), this will show up on statement of the counterparty.
counterpartyWire CounterpartyThe beneficiary party on the other end of the payment.
amountstringThe amount (cents) of the payment.
tagsobjectSee Tags.

Relationships#

NameTypeDescription
accountJSON:API RelationshipThe Deposit Account creating the payment.
customerOptional, JSON:API RelationshipThe Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customersOptional, Array of JSON:API RelationshipThe list of Customers the deposit account belongs to. This relationship is only available if the account belongs to a multiple individual customers.
transactionJSON:API RelationshipThe Wire Transaction generated by this payment.
Example WirePayment resource:
{  "type": "wireTransaction",  "id": "9547",  "attributes": {    "createdAt": "2020-07-05T15:49:36.864Z",    "direction": "Credit",    "amount": 1000,    "balance": 12000,    "summary": "Wire from Jane Smith",    "counterparty": {      "name": "Jane Smith",      "routingNumber": "812345678",      "accountNumber": "10039",      "accountType": "Checking"    }  },  "relationships": {    "account": {      "data": {        "type": "depositAccount",        "id": "10035"      }    },    "customer": {      "data": {        "type": "customer",        "id": "5"      }    }  }}

Originated ACH Transaction#

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

FieldtypeDescription
idstringIdentifier of the transaction resource.
typestringType of the transaction resource. The value is always originatedAchTransaction.
attributesJSON ObjectJSON object representing the transaction data.
relationshipsJSON:API RelationshipsDescribes relationships between the transaction resource and other resources (account and customer).

Attributes#

FieldtypeDescription
createdAtRFC3339 Date stringThe date the transaction was created. Common to all transaction types.
directionstringThe direction in which the funds flow. Common to all transaction types.
amountintegerThe amount (cents) of the transaction. Common to all transaction types.
balanceintegerThe account balance (cents) after the transaction. Common to all transaction types.
summarystringSummary of the transaction. Common to all transaction types.
descriptionstringTransaction description.
counterpartyCounterpartyThe party on the other end of the transaction.
tagsobjectSee Tags. Inherited from the payment tags (see Tag Inheritance).

Relationships#

FieldtypeDescription
accountJSON:API RelationshipThe Deposit Account of the customer.
customerOptional, JSON:API RelationshipThe Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customersOptional, Array of JSON:API RelationshipThe list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
paymentJSON:API RelationshipThe payment belonging to this transaction.
Example OriginatedAchTransaction resource:
{  "type": "originatedAchTransaction",  "id": "1",  "attributes": {    "createdAt": "2020-09-06T07:51:02.570Z",    "direction": "Credit",    "amount": 10000,    "balance": 10000,    "summary": "Counterparty: Unit Inc | Description: Funding",    "description": "Funding",    "counterparty": {      "name": "Unit Inc",      "routingNumber": "812345678",      "accountNumber": "1",      "accountType": "Checking"    }  },  "relationships": {    "account": {      "data": {        "type": "account",        "id": "10001"      }    },    "customer": {      "data": {        "type": "customer",        "id": "3"      }    },    "payment": {      "data": {        "type": "payment",        "id": "5"      }    }  }}

Received ACH Transaction#

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

FieldtypeDescription
idstringIdentifier of the transaction resource.
typestringType of the transaction resource. The value is always receivedAchTransaction.
attributesJSON ObjectJSON object representing the transaction data.
relationshipsJSON:API RelationshipsDescribes relationships between the transaction resource and other resources (account and customer).

Attributes#

FieldtypeDescription
createdAtRFC3339 Date stringThe date the transaction was created. Common to all transaction types.
directionstringThe direction in which the funds flow. Common to all transaction types.
amountintegerThe amount (cents) of the transaction. Common to all transaction types.
balanceintegerThe account balance (cents) after the transaction. Common to all transaction types.
summarystringSummary of the transaction. Common to all transaction types.
descriptionstringTransaction description.
addendastringOptional. Additional transaction description (maximum of 50 characters).
companyNamestringThe name by which the originator is known to the receiver.
counterpartyRoutingNumberstringThe routing number of the party that originated the ACH payment.
traceNumberstringThe ACH Trace Number.
secCodestringOptional. The 3-letter ACH Standard Entry Class (SEC) Code (e.g. WEB, CCD, PPD, etc.).
tagsobjectSee Tags.

Relationships#

FieldtypeDescription
accountJSON:API RelationshipThe Deposit Account of the customer.
customerOptional, JSON:API RelationshipThe Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customersOptional, Array of JSON:API RelationshipThe list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example ReceivedAchTransaction resource:
{  "type": "receivedAchTransaction",  "id": "4",  "attributes": {    "createdAt": "2020-09-08T12:41:43.360Z",    "direction": "Debit",    "amount": 80000,    "balance": 90000,    "summary": "Company: Unit Inc | Description: Payment from Unit Inc.",    "description": "Payment from Unit Inc.",    "companyName": "Unit Inc",    "counterpartyRoutingNumber": "812345678",    "traceNumber": "021214860002342",    "secCode": "WEB"  },  "relationships": {    "account": {      "data": {        "type": "account",        "id": "1"      }    },    "customer": {      "data": {        "type": "customer",        "id": "3"      }    }  }}

Returned ACH Transaction#

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

FieldtypeDescription
idstringIdentifier of the transaction resource.
typestringType of the transaction resource. The value is always returnedAchTransaction.
attributesJSON ObjectJSON object representing the transaction data.
relationshipsJSON:API RelationshipsDescribes relationships between the transaction resource and other resources (account and customer).

Attributes#

FieldtypeDescription
createdAtRFC3339 Date stringThe date the transaction was created. Common to all transaction types.
directionstringThe direction in which the funds flow. Common to all transaction types.
amountintegerThe amount (cents) of the transaction. Common to all transaction types.
balanceintegerThe account balance (cents) after the transaction. Common to all transaction types.
summarystringSummary of the transaction. Common to all transaction types.
companyNamestringThe name by which the originator is known to the receiver.
counterpartyNamestringThe name of the party that originated the ACH payment.
counterpartyRoutingNumberstringThe routing number of the party that originated the ACH payment.
reasonstringThe reason for the transaction return. See ACH return reasons.
tagsobjectSee Tags.

Relationships#

FieldtypeDescription
accountJSON:API RelationshipThe Deposit Account of the customer.
customerOptional, JSON:API RelationshipThe Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customersOptional, Array of JSON:API RelationshipThe list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
paymentJSON:API RelationshipThe returned payment.
Example ReturnedAchTransaction resource:
{  "type": "returnedAchTransaction",  "id": "4",  "attributes": {    "createdAt": "2020-09-08T12:41:43.360Z",    "direction": "Debit",    "amount": 1000,    "balance": 9000,    "summary": "Return due to: NoAccount | Counterparty: Unit Inc",    "companyName": "Unit Inc",    "counterpartyName": "Unit Inc",    "counterpartyRoutingNumber": "812345678",    "reason": "NoAccount"  },  "relationships": {    "account": {      "data": {        "type": "account",        "id": "1"      }    },    "customer": {      "data": {        "type": "customer",        "id": "3"      }    },    "payment": {      "data": {        "type": "payment",        "id": "1"      }    }  }}

Returned Received ACH Transaction#

The transaction is used to return a received ACH, automatically by Unit (e.g insufficient funds), by a dispute, or manually via Return Received ACH.

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

FieldtypeDescription
idstringIdentifier of the transaction resource.
typestringType of the transaction resource. The value is always returnedAchTransaction.
attributesJSON ObjectJSON object representing the transaction data.
relationshipsJSON:API RelationshipsDescribes relationships between the transaction resource and other resources (account and customer).

Attributes#

FieldtypeDescription
createdAtRFC3339 Date stringThe date the transaction was created. Common to all transaction types.
directionstringThe direction in which the funds flow. Common to all transaction types.
amountintegerThe amount (cents) of the transaction. Common to all transaction types.
balanceintegerThe account balance (cents) after the transaction. Common to all transaction types.
summarystringSummary of the transaction. Common to all transaction types.
companyNamestringThe name by which the originator is known to the receiver.
reasonstringThe reason for the transaction return. See ACH return reasons.
tagsobjectSee Tags.

Relationships#

FieldtypeDescription
accountJSON:API RelationshipThe Deposit Account of the customer.
customerOptional, JSON:API RelationshipThe Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customersOptional, Array of JSON:API RelationshipThe list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
returnedJSON:API RelationshipThe returned transaction.
Example ReturnedReceivedAchTransaction resource:
{  "type": "returnedReceivedAchTransaction",  "id": "4",  "attributes": {    "createdAt": "2020-09-08T12:41:43.360Z",    "direction": "Debit",    "amount": 1000,    "balance": 500,    "summary": "Returned received ACH transaction #55 due to: InsufficientFunds",    "companyName": "John Doe",    "reason": "InsufficientFunds"  },  "relationships": {    "account": {      "data": {        "type": "account",        "id": "1"      }    },    "customer": {      "data": {        "type": "customer",        "id": "3"      }    },    "returned": {      "data": {        "type": "transaction",        "id": "55"      }    }  }}

Dishonored ACH Transaction#

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

FieldtypeDescription
idstringIdentifier of the transaction resource.
typestringType of the transaction resource. The value is always receivedAchTransaction.
attributesJSON ObjectJSON object representing the transaction data.
relationshipsJSON:API RelationshipsDescribes relationships between the transaction resource and other resources (account and customer).

Attributes#

FieldtypeDescription
createdAtRFC3339 Date stringThe date the transaction was created. Common to all transaction types.
directionstringThe direction in which the funds flow. Common to all transaction types.
amountintegerThe amount (cents) of the transaction. Common to all transaction types.
balanceintegerThe account balance (cents) after the transaction. Common to all transaction types.
summarystringSummary of the transaction. Common to all transaction types.
descriptionstringTransaction description.
companyNamestringThe name by which the originator is known to the receiver.
counterpartyRoutingNumberstringThe routing number of the party that originated the ACH payment.
traceNumberstringThe ACH Trace Number.
reasonstringThe reason for the dishonored return.
secCodestringOptional. The 3-letter ACH Standard Entry Class (SEC) Code (e.g. WEB, CCD, PPD, etc.).
tagsobjectSee Tags.

Relationships#

FieldtypeDescription
accountJSON:API RelationshipThe Deposit Account of the customer.
customerOptional, JSON:API RelationshipThe Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customersOptional, Array of JSON:API RelationshipThe list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example DishonoredAchTransaction resource:
{  "type": "dishonoredAchTransaction",  "id": "423",  "attributes": {    "createdAt": "2021-03-11T12:24:51.360Z",    "direction": "Debit",    "amount": 61000,    "balance": 0,    "summary": "Company: Unit Inc | Description: Payment from Unit Inc.",    "description": "Payment from Unit Inc.",    "companyName": "Unit Inc",    "counterpartyRoutingNumber": "812345678",    "traceNumber": "021214860002342",    "secCode": "WEB"  },  "relationships": {    "account": {      "data": {        "type": "account",        "id": "1"      }    },    "customer": {      "data": {        "type": "customer",        "id": "3"      }    }  }}

Book Transaction#

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

FieldtypeDescription
idstringIdentifier of the transaction resource.
typestringType of the transaction resource. The value is always bookTransaction.
attributesJSON ObjectJSON object representing the transaction data.
relationshipsJSON:API RelationshipsDescribes relationships between the transaction resource and other resources (account and customer).
tagsobjectSee Tags. Inherited from the payment tags (see Tag Inheritance).

Attributes#

FieldtypeDescription
createdAtRFC3339 Date stringThe date the transaction was created. Common to all transaction types.
directionstringThe direction in which the funds flow. Common to all transaction types.
amountintegerThe amount (cents) of the transaction. Common to all transaction types.
balanceintegerThe account balance (cents) after the transaction. Common to all transaction types.
summarystringSummary of the transaction. Common to all transaction types.
counterpartyCounterpartyThe party on the other end of the transaction.

Relationships#

FieldtypeDescription
accountJSON:API RelationshipThe Deposit Account of the customer.
customerOptional, JSON:API RelationshipThe Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customersOptional, Array of JSON:API RelationshipThe list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
counterpartyAccountJSON:API RelationshipThe account of the counterparty.
counterpartyCustomerJSON:API RelationshipThe counterparty customer.
Example BookTransaction resource:
{  "type": "bookTransaction",  "id": "9547",  "attributes": {    "createdAt": "2020-07-05T15:49:36.864Z",    "direction": "Credit",    "amount": 1000,    "balance": 12000,    "summary": "Counterparty: Jane Smith | Description: Gift",    "counterparty": {      "name": "Jane Smith",      "routingNumber": "812345678",      "accountNumber": "10039",      "accountType": "Checking"    }  },  "relationships": {    "account": {      "data": {        "type": "depositAccount",        "id": "10035"      }    },    "customer": {      "data": {        "type": "customer",        "id": "5"      }    },    "counterpartyAccount": {      "data": {        "type": "account",        "id": "10036"      }    },    "counterpartyCustomer": {      "data": {        "type": "customer",        "id": "7"      }    }  }}

Purchase Transaction#

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

FieldtypeDescription
idstringIdentifier of the transaction resource.
typestringType of the transaction resource. The value is always purchaseTransaction.
attributesJSON ObjectJSON object representing the transaction data.
relationshipsJSON:API RelationshipsDescribes relationships between the transaction resource and other resources (account and customer).

Attributes#

FieldtypeDescription
createdAtRFC3339 Date stringThe date the transaction was created. Common to all transaction types.
directionstringThe direction in which the funds flow. Common to all transaction types.
amountintegerThe amount (cents) of the transaction. Common to all transaction types.
balanceintegerThe account balance (cents) after the transaction. Common to all transaction types.
summarystringSummary of the transaction. Common to all transaction types.
cardLast4DigitsstringThe last 4 digits of the debit card involved in the transaction.
merchant.namestringThe name of the merchant.
merchant.typeintegerThe 4-digit ISO 18245 merchant category code (MCC).
merchant.categorystringThe merchant category, described by the MCC code (see this reference for the list of category descriptions).
merchant.locationstringOptional. The location (city, state, etc.) of the merchant.
coordinatesCoordinatesOptional. Coordinates (latitude, longitude) of where the purchase took place.
recurringbooleanIndicates whether the transaction is recurring
tagsobjectSee Tags.

Relationships#

FieldtypeDescription
accountJSON:API RelationshipThe Deposit Account of the customer.
customerOptional, JSON:API RelationshipThe Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customersOptional, Array of JSON:API RelationshipThe list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
cardJSON:API RelationshipThe debit card involved in the transaction.
authorizationJSON:API RelationshipOptional. The Authorization request made by the merchant, if present (see Authorizations).
Example PurchaseTransaction resource:
{  "type": "purchaseTransaction",  "id": "51",  "attributes": {    "createdAt": "2020-09-08T12:41:43.360Z",    "direction": "Debit",    "amount": 2500,    "balance": 10523,    "summary": "Car rental",    "cardLast4Digits": "2282",    "merchant": {      "name": "Europcar Mobility Group",      "type": 3381,      "category": "EUROP CAR",      "location": "Cupertino, CA"    },    "coordinates": {      "longitude": -77.0364,      "latitude": 38.8951    },    "recurring": false  },  "relationships": {    "account": {      "data": {        "type": "account",        "id": "10001"      }    },    "customer": {      "data": {        "type": "customer",        "id": "3"      }    },    "card": {      "data": {        "type": "card",        "id": "11"      }    },    "authorization": {      "data": {        "type": "authorization",        "id": "40"      }    }  }}

ATM Transaction#

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

FieldtypeDescription
idstringIdentifier of the transaction resource.
typestringType of the transaction resource. The value is always atmTransaction.
attributesJSON ObjectJSON object representing the transaction data.
relationshipsJSON:API RelationshipsDescribes relationships between the transaction resource and other resources (account and customer).

Attributes#

FieldtypeDescription
createdAtRFC3339 Date stringThe date the transaction was created. Common to all transaction types.
directionstringThe direction in which the funds flow. Common to all transaction types.
amountintegerThe amount (cents) of the transaction, including the surcharge fee. Common to all transaction types.
balanceintegerThe account balance (cents) after the transaction. Common to all transaction types.
summarystringSummary of the transaction. Common to all transaction types.
cardLast4DigitsstringThe last 4 digits of the debit card involved in the transaction.
atmNamestringThe name of the ATM.
atmLocationstringOptional. The location (city, state, etc.) of the ATM.
surchargenumberThe surcharge fee (cents) for the transaction.
tagsobjectSee Tags.

Relationships#

FieldtypeDescription
accountJSON:API RelationshipThe Deposit Account of the customer.
customerOptional, JSON:API RelationshipThe Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customersOptional, Array of JSON:API RelationshipThe list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
cardJSON:API RelationshipThe debit card involved in the transaction.
Example AtmTransaction resource:
{  "type": "atmTransaction",  "id": "1432",  "attributes": {    "createdAt": "2020-07-05T15:49:36.864Z",    "direction": "Credit",    "amount": 10000,    "balance": 12000,    "summary": "ATM deposit",    "cardLast4Digits": "2282",    "atmName": "First National Bank",    "atmLocation": "Masontown, PA 15461",    "surcharge": 10  },  "relationships": {    "account": {      "data": {        "type": "depositAccount",        "id": "1000"      }    },    "customer": {      "data": {        "type": "customer",        "id": "3"      }    },    "card": {      "data": {        "type": "card",        "id": "11"      }    }  }}

Fee Transaction#

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

FieldtypeDescription
idstringIdentifier of the transaction resource.
typestringType of the transaction resource. The value is always feeTransaction.
attributesJSON ObjectJSON object representing the transaction data.
relationshipsJSON:API RelationshipsDescribes relationships between the transaction resource and other resources (account, customer and relatedTransaction).

Attributes#

FieldtypeDescription
createdAtRFC3339 Date stringThe date the transaction was created. Common to all transaction types.
directionstringThe direction in which the funds flow. Common to all transaction types.
amountintegerThe amount (cents) of the transaction. Common to all transaction types.
balanceintegerThe account balance (cents) after the transaction. Common to all transaction types.
summarystringSummary of the transaction. Common to all transaction types.
tagsobjectSee Tags.

Relationships#

FieldtypeDescription
accountJSON:API RelationshipThe Deposit Account of the customer.
customerOptional, JSON:API RelationshipThe Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customersOptional, Array of JSON:API RelationshipThe list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
relatedTransactionJSON:API RelationshipOptional. The transaction which the fee is subject to.
Example FeeTransaction resource:
{  "type": "feeTransaction",  "id": "388",  "attributes": {    "createdAt": "2020-09-08T12:41:43.360Z",    "direction": "Debit",    "amount": 10,    "balance": 89980,    "summary": "Payment fee for transaction #4"  },  "relationships": {    "account": {      "data": {        "type": "account",        "id": "10001"      }    },    "customer": {      "data": {        "type": "customer",        "id": "3"      }    },    "relatedTransaction": {      "data": {        "type": "transaction",        "id": "4"      }    }  }}

Card Reversal Transaction#

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

FieldtypeDescription
idstringIdentifier of the transaction resource.
typestringType of the transaction resource. The value is always cardReversalTransaction.
attributesJSON ObjectJSON object representing the transaction data.
relationshipsJSON:API RelationshipsDescribes relationships between the transaction resource and other resources (account, customer and relatedTransaction).

Attributes#

FieldtypeDescription
createdAtRFC3339 Date stringThe date the transaction was created. Common to all transaction types.
directionstringThe direction in which the funds flow. Common to all transaction types.
amountintegerThe amount (cents) of the transaction. Common to all transaction types.
balanceintegerThe account balance (cents) after the transaction. Common to all transaction types.
summarystringSummary of the transaction. Common to all transaction types.
cardLast4DigitsstringThe last 4 digits of the debit card involved in the transaction.
tagsobjectSee Tags.

Relationships#

FieldtypeDescription
accountJSON:API RelationshipThe Deposit Account of the customer.
customerOptional, JSON:API RelationshipThe Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customersOptional, Array of JSON:API RelationshipThe list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
relatedTransactionJSON:API RelationshipOptional. The transaction which the reversal is related to.
Example CardReversalTransaction resource:
{  "type": "cardReversalTransaction",  "id": "401",  "attributes": {    "createdAt": "2020-09-14T12:41:43.360Z",    "direction": "Debit",    "amount": 10,    "balance": 89980,    "summary": "Reversal for transaction #400",    "cardLast4Digits": "2282"  },  "relationships": {    "account": {      "data": {        "type": "account",        "id": "10001"      }    },    "customer": {      "data": {        "type": "customer",        "id": "1001"      }    },    "relatedTransaction": {      "data": {        "type": "transaction",        "id": "400"      }    }  }}

Card Transaction#

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

FieldtypeDescription
idstringIdentifier of the transaction resource.
typestringType of the transaction resource. The value is always cardTransaction.
attributesJSON ObjectJSON object representing the transaction data.
relationshipsJSON:API RelationshipsDescribes relationships between the transaction resource and other resources (account and customer).

Attributes#

FieldtypeDescription
createdAtRFC3339 Date stringThe date the transaction was created. Common to all transaction types.
directionstringThe direction in which the funds flow. Common to all transaction types.
amountintegerThe amount (cents) of the transaction. Common to all transaction types.
balanceintegerThe account balance (cents) after the transaction. Common to all transaction types.
summarystringSummary of the transaction. Common to all transaction types.
cardLast4DigitsstringThe last 4 digits of the debit card involved in the transaction.
tagsobjectSee Tags.

Relationships#

FieldtypeDescription
accountJSON:API RelationshipThe Deposit Account of the customer.
customerOptional, JSON:API RelationshipThe Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customersOptional, Array of JSON:API RelationshipThe list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example CardTransaction resource:
{  "type": "cardTransaction",  "id": "410",  "attributes": {    "createdAt": "2020-09-20T12:41:43.360Z",    "direction": "Debit",    "amount": 10,    "balance": 89480,    "summary": "Card transaction details",    "cardLast4Digits": "2282"  },  "relationships": {    "account": {      "data": {        "type": "account",        "id": "10001"      }    },    "customer": {      "data": {        "type": "customer",        "id": "1001"      }    }  }}

Wire Transaction#

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

FieldtypeDescription
idstringIdentifier of the transaction resource.
typestringType of the transaction resource. The value is always wireTransaction.
attributesJSON ObjectJSON object representing the transaction data.
relationshipsJSON:API RelationshipsDescribes relationships between the transaction resource and other resources (account and customer).

Attributes#

FieldtypeDescription
createdAtRFC3339 Date stringThe date the transaction was created. Common to all transaction types.
directionstringThe direction in which the funds flow. Common to all transaction types.
amountintegerThe amount (cents) of the transaction. Common to all transaction types.
balanceintegerThe account balance (cents) after the transaction. Common to all transaction types.
summarystringSummary of the transaction. Common to all transaction types.
counterpartyCounterpartyThe party on the other end of the transaction, either the beneficiary or the originator.
descriptionstringDescription of the transaction as entered by the originator. Also known as OBI or "Originator to Beneficiary Information".
senderReferencestringSender reference.
referenceForBeneficiarystringReference for the Beneficiary.
tagsobjectSee Tags.

Relationships#

FieldtypeDescription
accountJSON:API RelationshipThe Deposit Account of the customer.
customerOptional, JSON:API RelationshipThe Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customersOptional, Array of JSON:API RelationshipThe list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example WireTransaction resource:
{  "type": "wireTransaction",  "id": "9547",  "attributes": {    "createdAt": "2020-07-05T15:49:36.864Z",    "direction": "Credit",    "amount": 1000,    "balance": 12000,    "summary": "Wire from Jane Smith",    "counterparty": {      "name": "Jane Smith",      "routingNumber": "812345678",      "accountNumber": "10039",      "accountType": "Checking"    }  },  "relationships": {    "account": {      "data": {        "type": "depositAccount",        "id": "10035"      }    },    "customer": {      "data": {        "type": "customer",        "id": "5"      }    }  }}

Release Transaction#

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

FieldtypeDescription
idstringIdentifier of the transaction resource.
typestringType of the transaction resource. The value is always releaseTransaction.
attributesJSON ObjectJSON object representing the transaction data.
relationshipsJSON:API RelationshipsDescribes relationships between the transaction resource and other resources (account).

Attributes#

FieldtypeDescription
createdAtRFC3339 Date stringThe date the transaction was created. Common to all transaction types.
senderNamestringName of the sender.
senderAddressAddressAddress of the sender.
senderAccountNumberstringUnique 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.
counterpartyCounterpartyThe party who is releasing the funds
amountintegerThe amount (cents) of the transaction. Common to all transaction types.
directionstringThe direction in which the funds flow. Common to all transaction types. The value is always Credit.
descriptionstringDescription of the payment.
balanceintegerThe account balance (cents) after the transaction. Common to all transaction types.
summarystringSummary of the transaction. Common to all transaction types.
tagsobjectSee Tags.

Relationships#

FieldtypeDescription
accountJSON:API RelationshipThe Deposit Account receiving the funds.
Example ReleaseTransaction resource:
{  "type": "releaseTransaction",  "id": "258",  "attributes": {    "createdAt": "2020-12-08T15:38:07.394Z",    "senderName": "Richard Hendricks",    "senderAddress": {      "street": "5230 Newell Rd",      "city": "Palo Alto",      "state": "CA",      "postalCode": "94303",      "country": "US"    },    "senderAccountNumber": "123456798",    "counterparty": {      "name": "BatchAccount15",      "routingNumber": "812345678",      "accountNumber": "1000000096",      "accountType": "Checking"    },    "amount": 1000,    "direction": "Credit",    "description": "First Payment",    "balance": 1000,    "summary": "First Payment  |  Richard Hendricks"  },  "relationships": {    "account": {      "data": {        "type": "account",        "id": "10097"      }    }  }}

Adjustment Transaction#

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

FieldtypeDescription
idstringIdentifier of the transaction resource.
typestringType of the transaction resource. The value is always adjustmentTransaction.
attributesJSON ObjectJSON object representing the transaction data.
relationshipsJSON:API RelationshipsDescribes relationships between the transaction resource and other resources (account).

Attributes#

FieldtypeDescription
createdAtRFC3339 Date stringThe date the transaction was created. Common to all transaction types.
directionstringThe direction in which the funds flow. Common to all transaction types.
amountintegerThe amount (cents) of the transaction. Common to all transaction types.
balanceintegerThe account balance (cents) after the transaction. Common to all transaction types.
summarystringSummary of the transaction. Common to all transaction types.
descriptionstringDescription of the transaction.
tagsobjectSee Tags.

Relationships#

FieldtypeDescription
accountJSON:API RelationshipThe Deposit Account participating in the transaction.
Example AdjustmentTransaction resource:
{  "type": "adjustmentTransaction",  "id": "215",  "attributes": {    "createdAt": "2021-04-12T16:08:39.040Z",    "amount": 5000,    "direction": "Debit",    "balance": 3124000,    "summary": "correction of transaction #200",    "description": "correction of transaction #200"  },  "relationships": {    "account": {      "data": {        "type": "account",        "id": "10001"      }    },    "customer": {      "data": {        "type": "customer",        "id": "10000"      }    }  }}

Interest Transaction#

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

FieldtypeDescription
idstringIdentifier of the transaction resource.
typestringType of the transaction resource. The value is always interestTransaction.
attributesJSON ObjectJSON object representing the transaction data.
relationshipsJSON:API RelationshipsDescribes relationships between the transaction resource and other resources (account and customer).

Attributes#

FieldtypeDescription
createdAtRFC3339 Date stringThe date the transaction was created. Common to all transaction types.
directionstringThe direction in which the funds flow. Common to all transaction types.
amountintegerThe amount (cents) of the transaction. Common to all transaction types.
balanceintegerThe account balance (cents) after the transaction. Common to all transaction types.
summarystringSummary of the transaction. Common to all transaction types.
tagsobjectSee Tags.

Relationships#

FieldtypeDescription
accountJSON:API RelationshipThe Deposit Account of the customer.
customerOptional, JSON:API RelationshipThe Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customersOptional, Array of JSON:API RelationshipThe list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example InterestTransaction resource:
{  "type": "interestTransaction",  "id": "9547",  "attributes": {    "createdAt": "2020-07-05T15:49:36.864Z",    "direction": "Credit",    "amount": 1000,    "balance": 12000,    "summary": "Interest March 2020"  },  "relationships": {    "account": {      "data": {        "type": "depositAccount",        "id": "10035"      }    },    "customer": {      "data": {        "type": "customer",        "id": "5"      }    }  }}

Dispute Transaction#

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

FieldtypeDescription
idstringIdentifier of the transaction resource.
typestringType of the transaction resource. The value is always disputeTransaction.
attributesJSON ObjectJSON object representing the transaction data.
relationshipsJSON:API RelationshipsDescribes relationships between the transaction resource and other resources (account, customer).

Attributes#

FieldtypeDescription
createdAtRFC3339 Date stringThe date the transaction was created. Common to all transaction types.
directionstringThe direction in which the funds flow. Common to all transaction types.
amountintegerThe amount (cents) of the transaction. Common to all transaction types.
balanceintegerThe account balance (cents) after the transaction. Common to all transaction types.
disputeIdstringUnique ID of the dispute that is related to the transaction.
summarystringSummary of the transaction. Common to all transaction types.
reasonstringThe reason for the dispute transaction, one of: ProvisionalCredit, ProvisionalCreditReversalDenied, ProvisionalCreditReversalResolved, FinalCredit.
tagsobjectSee Tags.

Relationships#

FieldtypeDescription
accountJSON:API RelationshipThe Deposit Account participating in the transaction.
customerOptional, JSON:API RelationshipThe Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customersOptional, Array of JSON:API RelationshipThe list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example DisputeTransaction resource:
{  "type": "disputeTransaction",  "id": "226",  "attributes": {    "createdAt": "2021-04-19T12:44:08.055Z",    "amount": 2500,    "direction": "Credit",    "balance": 550000,    "summary": "Dispute 119 | Provisional Credit",    "reason": "ProvisionalCredit"  },  "relationships": {    "account": {      "data": {        "type": "account",        "id": "10001"      }    },    "customer": {      "data": {        "type": "customer",        "id": "10000"      }    }  }}

Check Deposit Transaction#

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

FieldtypeDescription
idstringIdentifier of the transaction resource.
typestringType of the transaction resource. The value is always checkDepositTransaction.
attributesJSON ObjectJSON object representing the transaction data.
relationshipsJSON:API RelationshipsDescribes relationships between the transaction resource and other resources (account, customer, checkDeposit).

Attributes#

FieldtypeDescription
createdAtRFC3339 Date stringThe date the transaction was created. Common to all transaction types.
directionstringThe direction in which the funds flow. Common to all transaction types.
amountintegerThe amount (cents) of the transaction. Common to all transaction types.
balanceintegerThe account balance (cents) after the transaction. Common to all transaction types.
summarystringSummary of the transaction. Common to all transaction types.
tagsobjectSee Tags.

Relationships#

FieldtypeDescription
accountJSON:API RelationshipThe Deposit Account participating in the transaction.
customerOptional, JSON:API RelationshipThe Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customersOptional, Array of JSON:API RelationshipThe list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
checkDepositJSON:API RelationshipThe Check Deposit the transaction is related to.
Example CheckDepositTransaction resource:
{  "data": {    "type": "checkDepositTransaction",    "id": "264",    "attributes": {      "createdAt": "2021-06-06T07:21:51.467Z",      "amount": 200,      "direction": "Credit",      "balance": 371600,      "summary": "Check deposit"    },    "relationships": {      "account": {        "data": {          "type": "account",          "id": "10001"        }      },      "customer": {        "data": {          "type": "customer",          "id": "10000"        }      },      "checkDeposit": {        "data": {          "type": "checkDeposit",          "id": "122"        }      }    }  }}

Returned Check Deposit Transaction#

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

FieldtypeDescription
idstringIdentifier of the transaction resource.
typestringType of the transaction resource. The value is always returnedCheckDepositTransaction.
attributesJSON ObjectJSON object representing the transaction data.
relationshipsJSON:API RelationshipsDescribes relationships between the transaction resource and other resources (account, customer, checkDeposit).

Attributes#

FieldtypeDescription
createdAtRFC3339 Date stringThe date the transaction was created. Common to all transaction types.
directionstringThe direction in which the funds flow. Common to all transaction types.
amountintegerThe amount (cents) of the transaction. Common to all transaction types.
balanceintegerThe account balance (cents) after the transaction. Common to all transaction types.
summarystringSummary of the transaction. Common to all transaction types.
reasonstringThe reason for the transaction return.
tagsobjectSee Tags.

Relationships#

FieldtypeDescription
accountJSON:API RelationshipThe Deposit Account participating in the transaction.
customerOptional, JSON:API RelationshipThe Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customersOptional, Array of JSON:API RelationshipThe list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
checkDepositJSON:API RelationshipThe Check Deposit the transaction is related to.
Example ReturnedCheckDepositTransaction resource:
{  "data": {    "type": "returnedCheckDepositTransaction",    "id": "265",    "attributes": {      "createdAt": "2021-06-06T07:23:30.101Z",      "amount": 200,      "direction": "Debit",      "balance": 3716500,      "summary": "Returned due to: Insufficient Funds  |  Check deposit",      "reason": "Insufficient Funds"    },    "relationships": {      "account": {        "data": {          "type": "account",          "id": "10001"        }      },      "customer": {        "data": {          "type": "customer",          "id": "10000"        }      },      "checkDeposit": {        "data": {          "type": "checkDeposit",          "id": "122"        }      }    }  }}

Authorization#

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

FieldtypeDescription
idstringIdentifier of the authorization resource.
typestringType of the authorization resource. The value is always authorization.
attributesJSON ObjectJSON object representing the authorization data.
relationshipsJSON:API RelationshipsDescribes relationships between the authorization resource and other resources (account and customer).

Attributes#

FieldtypeDescription
createdAtRFC3339 Date stringThe date the authorization was created.
amountintegerThe amount (cents) of the authorization.
cardLast4DigitsstringThe last 4 digits of the debit card involved in the authorization.
merchant.namestringThe name of the merchant.
merchant.typeintegerThe 4-digit ISO 18245 merchant category code (MCC).
merchant.categorystringThe merchant category, described by the MCC code (see this reference for the list of category descriptions).
merchant.locationstringOptional. The location (city, state, etc.) of the merchant.
recurringbooleanIndicates whether the authorization is recurring

Relationships#

FieldtypeDescription
accountJSON:API RelationshipThe Deposit Account of the customer.
customerOptional, JSON:API RelationshipThe Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
cardJSON:API RelationshipThe debit card involved in the authorization.
customersOptional, Array of JSON:API RelationshipThe list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example Authorization resource:
{  "type": "authorization",  "id": "97",  "attributes": {    "createdAt": "2021-02-21T07:29:42.447Z",    "amount": 2000,    "cardLast4Digits": "0019",    "merchant": {      "name": "Europcar Mobility Group",      "type": 3381,      "category": "EUROP CAR",      "location": "Cupertino, CA"    },    "recurring": false  },  "relationships": {    "customer": {      "data": {        "type": "customer",        "id": "10000"      }    },    "account": {      "data": {        "type": "account",        "id": "10001"      }    },    "card": {      "data": {        "type": "card",        "id": "10501"      }    }  }}

Purchase Authorization Request#

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

FieldtypeDescription
idstringIdentifier of the purchase authorization request resource.
typestringType of the purchase authorization request resource. The value is always purchaseAuthorizationRequest.
attributesJSON ObjectJSON object representing the authorization request data.
relationshipsJSON:API RelationshipsDescribes relationships between the authorization request resource and other resources (account, customer and card).

Attributes#

FieldtypeDescription
createdAtRFC3339 Date stringThe date the authorization request was created.
amountintegerThe amount (cents) of the authorization request.
statusstringThe status of the authorization request. Either Pending, Approved or Declined.
partialApprovalAllowedbooleanIndicates whether the authorization request supports partial amount approval.
approvedAmountintegerOptional. The amount (cents) that was approved. Available only when status is Approved.
declineReasonstringOptional. The reason the authorization request was declined. One of AccountClosed, CardExceedsAmountLimit, DoNotHonor, InsufficientFunds, InvalidMerchant, ReferToCardIssuer, RestrictedCard, Timeout, TransactionNotPermittedToCardholder. Available only when status is Declined
merchant.namestringThe name of the merchant.
merchant.typeintegerThe 4-digit ISO 18245 merchant category code (MCC).
merchant.categorystringThe merchant category, described by the MCC code (see this reference for the list of category descriptions).
merchant.locationstringOptional. The location (city, state, etc.) of the merchant.
recurringbooleanIndicates whether the authorization is recurring

Relationships#

FieldtypeDescription
accountJSON:API RelationshipThe Deposit Account of the customer.
customerOptional, JSON:API RelationshipThe Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customersOptional, Array of JSON:API RelationshipThe list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
cardJSON:API RelationshipThe debit card used in the purchase.
Example PurchaseAuthorizationRequest resource:
{  "type": "purchaseAuthorizationRequest",  "id": "1",  "attributes": {    "createdAt": "2021-06-22T13:39:17.018Z",    "amount": 2500,    "status": "Pending",    "partialApprovalAllowed": false,    "merchant": {      "name": "Apple Inc.",      "type": 1000,      "category": "",      "location": "Cupertino, CA"    },    "recurring": false  },  "relationships": {    "customer": {      "data": {        "type": "customer",        "id": "10000"      }    },    "account": {      "data": {        "type": "account",        "id": "10001"      }    },    "card": {      "data": {        "type": "card",        "id": "7"      }    }  }}

Statement#

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

FieldtypeDescription
idstringIdentifier of the statement resource.
typestringType of the statement resource. The value is always statement.
attributesJSON ObjectJSON object representing the statement data.
relationshipsJSON:API RelationshipsDescribes relationships between the statement resource and other resources (account and customer).

Attributes#

FieldtypeDescription
periodstringPeriod of the statement, formatted YYYY-MM, e.g "2020-05".

Relationships#

FieldtypeDescription
accountJSON:API RelationshipThe account for which the statement was produced.
customerOptional, JSON:API RelationshipThe Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customersOptional, Array of JSON:API RelationshipThe list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example Statement resource:
{  "type": "statement",  "id": "1",  "attributes": {    "period": "2020-07"  },  "relationships": {    "account": {      "data": {        "type": "account",        "id": "1000"      }    },    "customer": {      "data": {        "type": "customer",        "id": "1"      }    }  }}

BatchRelease#

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

FieldtypeDescription
idstringIdentifier of the batch-release resource.
typestringType of the batch-release resource. The value is always batchRelease.
attributesJSON ObjectJSON object representing the batch-release data.
relationshipsJSON:API RelationshipsDescribes relationships between the batch-release resource and other resources (accounts).

Attributes#

NameTypeDescription
amountintegerThe amount (in cents) to move from the batch account to the receiver account.
descriptionstringDescription of the payment.
senderNamestringName of the sender, before combining the payments.
senderAddressAddressAddress of the sender.
senderAccountNumberstringUnique identifier to monitor for similar sending accounts, could be the BIN + last four digits of the card number OR a unique identifier generated by you for the sender.

Relationships#

NameTypeDescription
batchAccountJSON:API RelationshipThe batch account to release the funds from.
receiverJSON:API RelationshipThe account to release the funds to.
Example BatchRelease resource:
{  "type": "batchRelease",  "id": "100123",  "attributes": {    "amount": 3000,    "description": "Gift",    "senderName": "Sherlock Holmes",    "senderAccountNumber": "4581133972",    "senderAddress": {      "street": "221B Baker Street",      "city": "London",      "postalCode": "NW1 6XE",      "country": "UK"    }  },  "relationships": {    "batchAccount": {      "data": {        "type": "batchAccount",        "id": "10104"      }    },    "receiver": {      "data": {        "type": "depositAccount",        "id": "10097"      }    }  }}

Fee#

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

FieldtypeDescription
idstringIdentifier of the fee resource.
typestringType of the fee resource. The value is always fee.
attributesJSON ObjectJSON object representing the fee data.
relationshipsJSON:API RelationshipsDescribes relationships between the fee resource and other resources (accounts).

Attributes#

NameTypeDescription
amountintegerThe amount (in cents) of the fee.
descriptionstringDescription of the fee.
tagsobjectSee Tags.

Relationships#

NameTypeDescription
accountJSON:API RelationshipThe account the fee belongs to.
Example Fee resource:
{  "data": {    "type": "fee",    "id": "1234",    "attributes": {      "amount": 1000,      "description": "Monthly Subscription"    },    "relationships": {      "account": {        "data": {          "type": "depositAccount",          "id": "10097"        }      }    }  }}

Event#

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

FieldtypeDescription
idstringIdentifier of the event resource.
typestringType of the event resource.
attributesJSON ObjectJSON object representing the event data, based on the event type. See Events.
relationshipsJSON:API RelationshipsDescribes relationships between the event resource and other resources, based on the event type. See Events.
Example Event resource:
{  "data": [    {      "id": "230",      "type": "transaction.created",      "attributes": {        "createdAt": "2021-03-15T07:49:09.089Z",        "amount": 10000,        "direction": "Credit",        "summary": "Wire from Sender"      },      "relationships": {        "account": {          "data": {            "id": "10005",            "type": "account"          }        },        "transaction": {          "data": {            "id": "189",            "type": "wireTransaction"          }        },        "customer": {          "data": {            "id": "10000",            "type": "individualCustomer"          }        }      }    }  ]}

Webhook#

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

FieldtypeDescription
idstringIdentifier of the webhook resource.
typestringType of the webhook resource. The value is always webhook.
attributesJSON ObjectJSON object representing the webhook data.

Attributes#

NameTypeDescription
createdAtRFC3339 Date stringThe date the webhook was created.
labelstringA label describing the webhook.
urlstringThe URL of the webhook endpoint.
statusstringThe status of the webhook. Either Enabled or Disabled.
contentTypestringThe type of content you wish to receive. Either Json or JsonAPI.
tokenstringThe secret token (see Securing your webhooks).
Example Webhook resource:
{  "data": {    "type": "webhook",    "id": "15",    "attributes": {      "createdAt": "2021-04-28T09:35:01.028Z",      "label": "some label",      "url": "https://webhook.site/81ee6b53-fde4-4b7d-85a0-0b6249a4488d",      "status": "Enabled",      "contentType": "Json",      "token": "MyToken"    }  }}

APIToken#

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

FieldtypeDescription
idstringIdentifier of the api token resource.
typestringType of the api token resource. The value is always apiToken.
attributesJSON ObjectJSON object representing the api token data.

Attributes#

NameTypeDescription
createdAtRFC3339 Date stringThe date the API token was created.
descriptionstringA description of the API token.
expirationRFC3339 Date stringExpiration date of the API token.
tokenstringOptional. The actual bearer token. Available only on API token creation response.
sourceIpstringOptional. A comma separated list of IP addresses that are allowed to use the API token.
Example APIToken resource:
{  "data": {    "id": "20",    "type": "apiToken",    "attributes": {      "createdAt": "2021-07-01T09:04:50.987Z",      "description": "Production token",      "expiration": "2022-07-01T13:47:17.000Z",      "token": "v2.public.eyJyb2xlIjoib3JnI..."    }  }}

Account End-Of-Day#

Account End-Of-Day is a JSON:API resource, top-level fields:

FieldtypeDescription
idstringIdentifier of the account end-of-day resource.
typestringType of the account end-of-day resource. The value is always accountEndOfDay.
attributesJSON ObjectJSON object representing the account end-of-day data.
relationshipsJSON:API RelationshipsDescribes relationships between the statement resource and other resources (account and customer).

Attributes#

NameTypeDescription
dateISO Local Date stringThe date the account end-of-day resource was created.
balanceintegerThe balance amount (in cents).
holdintegerThe hold amount (in cents).
availableintegerThe available balance for spending (in cents).

Relationships#

FieldtypeDescription
accountJSON:API RelationshipThe account the resource belongs to.
customerOptional, JSON:API RelationshipThe Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customersOptional, Array of JSON:API RelationshipThe list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example Account End-Of-Day resource:
{  "type": "accountEndOfDay",  "id": "4925158",  "attributes": {    "date": "2021-07-10",    "balance": 1000,    "available": 500,    "hold": 500  },  "relationships": {    "customer": {      "data": {        "type": "customer",        "id": "10000"      }    },    "account": {      "data": {        "type": "account",        "id": "30317"      }    }  }}

PinStatus#

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

FieldtypeDescription
typestringType of the PinStatus resource. The value is always pinStatus.
attributesJSON ObjectJSON object representing the PinStatus data.

Attributes#

NameTypeDescription
statusstringStatus of the PIN, either Set or NotSet.
Example PinStatus resource:
{  "data": {    "type": "pinStatus",    "attributes": {      "status": "NotSet"    }  }}

Check Deposit#

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

FieldtypeDescription
idstringIdentifier of the check deposit resource.
typestringType of the check deposit resource. The value is always checkDeposit.
attributesJSON ObjectJSON object representing the check deposit resource.
relationshipsJSON:API RelationshipsDescribes relationships between the check deposit resource and other resources

Attributes#

NameTypeDescription
createdAtRFC3339 Date stringThe date the resource was created.
statusstringOne of AwaitingImages, AwaitingFrontImage, AwaitingBackImage, Pending, PendingReview, Rejected, Clearing, Sent, Canceled, Returned.
reasonstring(Optional) More information about the status.
descriptionstringCheck Deposit description (maximum of 50 characters).
amountstringThe amount (cents) of the check deposit.
tagsobjectSee Tags.

Relationships#

NameTypeDescription
accountJSON:API RelationshipThe Deposit Account receiving the check deposit.
customerOptional, JSON:API RelationshipThe Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customersOptional, Array of JSON:API RelationshipThe list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
transactionJSON:API RelationshipThe Check Deposit Transaction generated by this check deposit.
Example CheckDeposit resource:
{  "data": {    "type": "checkDeposit",    "id": "11221",    "attributes": {      "createdAt": "2021-05-27T09:29:30.828Z",      "amount": 20000,      "description": "Check deposit",      "status": "AwaitingImages"    },    "relationships": {      "account": {        "data": {          "type": "account",          "id": "10001"        }      },      "customer": {        "data": {          "type": "customer",          "id": "10000"        }      }    }  }}

Institution#

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

FieldtypeDescription
typestringType of the institution resource. The value is always institution.
attributesJSON ObjectJSON object representing the institution data.

Attributes#

NameTypeDescription
routingNumberstringRouting number of the institution. Valid 9-digit ABA routing transit number.
namestringName of the institution.
addressstringOptional. Address of the institution.
isACHSupportedbooleanIs FedACH participant.
isWireSupportedbooleanIs Fedwire participant.
Example Institution resource:
{  "type": "institution",  "attributes": {    "routingNumber": "091311229",    "name": "Choice Financial Group",    "address": "Ste 300 Fargo ND 58104",    "isACHSupported": true,    "isWireSupported": false  }}

ApplicationForm#

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

FieldtypeDescription
idstringIdentifier of the application form resource.
typestringType of the application form resource. The value is always applicationForm.
attributesJSON ObjectJSON object representing the application form data.
relationshipsJSON:API RelationshipsDescribes relationships between the application form resource and other resources

Attributes#

FieldTypeDescription
tagsobjectSee Tags. Tags that will be copied to the application that this form creates (see Tag Inheritance).
urlstringThe URL of the application form for the end-customer to access
stagestringCurrent stage of the application form, one of: ChooseBusinessOrIndividual, EnterIndividualInformation, IndividualApplicationCreated, EnterBusinessInformation, EnterOfficerInformation, EnterBeneficialOwnersInformation, BusinessApplicationCreated, EnterSoleProprietorshipInformation, SoleProprietorshipApplicationCreated
applicantDetailsApplicationFormPrefillData that is already known about the end-customer to be auto populated on the form.

Relationships#

NameTypeDescription
applicationOptional, JSON:API RelationshipThe Application resource that the application form has created. This relationship is only available if the application form has been completed by an end-customer and an application has been submitted.
Example ApplicationForm resource:
{  "data": {    "type": "applicationForm",    "id": "95",    "attributes": {      "tags": {        "userId": "106a75e9-de77-4e25-9561-faffe59d7814"      },      "url": "https://application-form.sh/6YZ3UG6RS7NGTO5ZB3A4SRO3NEYPJUREYIIKZDOOX2CTWBPZ4A343UB4KZSQRF3DHHKYECF4S45VP7Y2YUP5WGEHO4YVH25Q24JRM4UA5IW3OM552HAFJ3HIVIUJGJBFQ4UJMZ3VGXUG6L5XFKE2W7YX7KDOC2J",      "stage": "IndividualApplicationCreated",      "applicantDetails": {        "applicationType": "Individual",        "fullName": {          "first": "Peter",          "last": "Parker"        },        "passport": "12345678",        "nationality": "US",        "dateOfBirth": "2001-08-10",        "email": "peter@oscorp.com",        "name": "Pied Piper",        "stateOfIncorporation": "DE",        "entityType": "Corporation",        "address": {          "street": "5230 Newell Rd",          "city": "Palo Alto",          "state": "CA",          "postalCode": "94303",          "country": "US"        },        "phone": {          "countryCode": "1",          "number": "2025550187"        }      }    },    "relationships": {      "application": {        "data": {          "type": "application",          "id": "10098"        }      }    }  }}

ATM Location#

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

FieldtypeDescription
typestringType of the ATM location resource. The value is always atmLocation.
attributesJSON ObjectJSON object representing the ATM location data.

Attributes#

NameTypeDescription
networkstringName of the ATM network.
locationNamestringName of the ATM's location.
coordinatesCoordinatesCoordinates (latitude, longitude) of the ATM.
addressstringAddress of the ATM.
distancenumberDistance to the ATM (in miles).
surchargeFreebooleanIndicates if the ATM is surcharge free.
acceptDepositsbooleanIndicates if the ATM accepts deposits.
Example ATM Location resource:
{  "type": "atmLocation",  "attributes": {    "network": "Allpoint",    "locationName": "SPEEDWAY",    "coordinates": {      "longitude": -73.93041,      "latitude": 42.79894    },    "address": {      "street": "229 S BRANDYWINE AVE",      "city": "SCHENECTADY",      "state": "NY",      "postalCode": "12307",      "country": "US"    },    "distance": "1.07 miles",    "surchargeFree": true,    "acceptDeposits": false  }}