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.
updatedAtRFC3339 Date stringOptional. The date the resource was updated.
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.
industryOptional. IndustryOptional. Indicates if the individual is a sole proprietor who has an business industry, if specified.
dbastringOptional. Indicates if the individual is a sole proprietor who is doing business under a different name, if specified.
archivedbooleanIndicates whether the application has been archived. Archived applications are read-only and no changes can be made to them. Once an application has been archived, a new application with the same SSN (or Passport) may be submitted. An application becomes archived once the corresponding customer is archived.
powerOfAttorneyAgentAgentOptional. The details of the person that will act as the agent that has power of attorney.
tagsobjectSee Tags.

Relationships#

FieldtypeDescription
documentsArray of JSON:API RelationshipOptional. Application'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.",    "archived": false,    "tags": {      "userId": "106a75e9-de77-4e25-9561-faffe59d7814"    }  },  "relationships": {    "org": {      "data": {        "type": "org",        "id": "1"      }    },    "documents": {      "data": [        {          "type": "document",          "id": "1"        },        {          "type": "document",          "id": "2"        }      ]    },    "applicationForm": {      "data": {        "type": "applicationForm",        "id": "3"      }    }  }}

Reward Transaction#

A rewardTransaction represents a successful reward creation.

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

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

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, this will be the description of the reward.
receiverCounterpartyCounterpartyThe receiving party 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.
rewardJSON:API RelationshipThe reward belonging to this transaction.
receiverAccountJSON:API RelationshipThe Deposit Account receiver.
Example RewardTransaction resource:
{  "data": {    "type": "rewardTransaction",    "id": "51",    "attributes": {      "createdAt": "2022-04-05T10:46:34.371Z",      "receiverCounterparty": {        "name": "Unit Finance Inc.",        "routingNumber": "091311229",        "accountNumber": "864800000000",        "accountType": "Checking"      },      "amount": 800,      "direction": "Credit",      "balance": 113000,      "summary": "My Reward 8",      "tags": {        "customer_type": "vip"      }    },    "relationships": {      "account": {        "data": {          "type": "account",          "id": "10001"        }      },      "customer": {        "data": {          "type": "customer",          "id": "10000"        }      },      "customers": {        "data": [          {            "type": "customer",            "id": "10000"          }        ]      },      "org": {        "data": {          "type": "org",          "id": "1"        }      },      "reward": {        "data": {          "type": "reward",          "id": "1"        }      },      "receiverAccount": {        "data": {          "type": "account",          "id": "10000"        }      }    }  }}

Account Low Balance Closure Transaction#

An accountLowBalanceClosureTransaction represents account low balance closure transaction.

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

FieldtypeDescription
idstringIdentifier of the transaction resource.
typestringType of the transaction resource. The value is always accountLowBalanceClosureTransaction.
attributesJSON ObjectJSON object representing the transaction data.
relationshipsJSON:API RelationshipsDescribes relationships between the transaction resource and other resources (accounts, 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.
receiverCounterpartyCounterpartyThe receiving party 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.
receiverAccountJSON:API RelationshipThe Deposit Account receiver.
Example AccountLowBalanceClosureTransaction resource:
{  "data": {    "type": "accountLowBalanceClosureTransaction",    "id": "53",    "attributes": {      "createdAt": "2022-04-06T10:46:34.371Z",      "receiverCounterparty": {        "name": "Unit Finance Inc.",        "routingNumber": "091311229",        "accountNumber": "864800000000",        "accountType": "Checking"      },      "amount": 800,      "direction": "Credit",      "balance": 113000,      "summary": "Account Low Balance Closure",      "tags": {        "customer_type": "vip"      }    },    "relationships": {      "account": {        "data": {          "type": "account",          "id": "10001"        }      },      "customer": {        "data": {          "type": "customer",          "id": "10000"        }      },      "customers": {        "data": [          {            "type": "customer",            "id": "10000"          }        ]      },      "org": {        "data": {          "type": "org",          "id": "1"        }      },      "receiverAccount": {        "data": {          "type": "account",          "id": "10000"        }      }    }  }}

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.
updatedAtRFC3339 Date stringOptional. The date the resource was updated.
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).
industryOptional. IndustryOptional. Business industry, if specified.
entityTypestringOne of "Corporation", "LLC" or "Partnership".
contactBusinessContactPrimary contact of the business.
officerOfficerOfficer representing the business, must be the CEO, COO, CFO, President, BenefitsAdministrationOfficer, CIO, VP, AVP, Treasurer, Secretary, Controller, Manager, Partner or Member. The officer would need to go over KYC process and provide documents.
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.
archivedbooleanIndicates whether the application has been archived. Archived applications are read-only and no changes can be made to them. An application becomes archived once the corresponding customer is archived.
tagsobjectSee Tags.

Relationships#

FieldtypeDescription
documentsArray of JSON:API RelationshipOptional. Application'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"    },    "archived": false,    "status": "AwaitingDocuments",    "message": "Waiting for you to upload the required documents."  },  "relationships": {    "org": {      "data": {        "type": "org",        "id": "1"      }    },    "documents": {      "data": [        {          "type": "document",          "id": "1"        },        {          "type": "document",          "id": "2"        },        {          "type": "document",          "id": "3"        }      ]    },    "applicationForm": {      "data": {        "type": "applicationForm",        "id": "3"      }    }  }}

TrustApplication#

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

FieldtypeDescription
idstringIdentifier of the application resource.
typestringType of the application resource, for trust application the value is always trustApplication.
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 TrustApplication status.
createdAtRFC3339 Date stringThe date the resource was created.
updatedAtRFC3339 Date stringOptional. The date the resource was updated.
namestringName of the trust.
stateOfIncorporationstringTwo letters representing a US state.
revocabilityEither Revocable or IrrevocableWhether the trust can be changed or canceled after the trust document has been signed.
sourceOfFundsOne of Inheritance, Salary, Savings, InvestmentReturns, GiftsOrigin of the funds used to fund the account.
taxIdstringThe grantor's SSN.
grantorGrantorThe individual that creates the trust.
contactTrustContactPrimary contact of the trust.
archivedbooleanIndicates whether the application has been archived. Archived applications are read-only and no changes can be made to them. An application becomes archived once the corresponding customer is archived.
tagsobjectSee Tags.

Relationships#

FieldtypeDescription
documentsArray of JSON:API RelationshipApplication's documents.
customerJSON:API RelationshipOptional. The created Customer in case of approved application.
trusteesJSON:API RelationshipThe trustees of the trust.
beneficiariesJSON:API RelationshipThe beneficiaries of the trust.
Example TrustApplication resource:
{  "type": "trustApplication",  "id": "51",  "attributes": {    "createdAt": "2022-04-02T21:59:46.324Z",    "name": "Trust me Inc.",    "contact": {      "fullName": {        "first": "Jared",        "last": "Dunn"      },      "email": "jared@piedpiper.com",      "phone": {        "countryCode": "1",        "number": "2025550108"      },      "address": {        "street": "5230 Newell Rd",        "city": "Palo Alto",        "state": "CA",        "postalCode": "94303",        "country": "US"      }    },    "status": "AwaitingDocuments",    "message": "Waiting for you to upload the required documents.",    "stateOfIncorporation": "CA",    "revocability": "Revocable",    "sourceOfFunds": "Salary",    "taxId": "123456789",    "grantor": {      "status": "PendingReview",      "fullName": {        "first": "Laurie",        "last": "Bream"      },      "ssn": "000000003",      "address": {        "street": "950 Allerton Street",        "city": "Redwood City",        "state": "CA",        "postalCode": "94063",        "country": "US"      },      "dateOfBirth": "2000-01-01",      "email": "laurie@raviga.com",      "phone": {        "countryCode": "1",        "number": "2025550108"      }    },    "tags": {      "test": "test1"    },    "archived": false  },  "relationships": {    "org": {      "data": {        "type": "org",        "id": "1"      }    },    "trustees": {      "data": [        {          "type": "trustee",          "id": "21"        }      ]    },    "beneficiaries": {      "data": [        {          "type": "beneficiary",          "id": "33"        },        {          "type": "beneficiary",          "id": "34"        }      ]    },    "documents": {      "data": [        {          "type": "document",          "id": "201"        },        {          "type": "document",          "id": "202"        },        {          "type": "document",          "id": "203"        }      ]    }  }}

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, EmployerIdentificationNumberConfirmation, SocialSecurityCard, PowerOfAttorney, ClientRequested or SelfieVerification.
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 IdDocument 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"  }}

BeneficialOwner#

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

FieldtypeDescription
idstringIdentifier of the beneficial owner resource.
typestringAlways beneficialOwner.
attributesJSON ObjectJSON object representing the beneficial owner’s data.

Attributes#

FieldtypeDescription
statusstringOne of Approved, Denied or PendingReview.
fullNameFullNameFull name of the beneficial owner.
ssnstringSSN of the beneficial owner (numbers only). One of ssn or passport is required.
passportstringPassport of the beneficial owner. One of ssn or passport is required.
nationalityISO31661-Alpha2 stringOnly when Passport is populated. Two letters representing the beneficial owner's nationality.
dateOfBirthRFC3339 Date stringDate only (e.g. "2001-08-15").
addressAddressThe beneficial owner's address.
phonePhoneThe beneficial owner's phone number.
emailstringThe beneficial owner's email address.
Example BeneficialOwner resource:
{  "type": "beneficialOwner",  "id": "5",  "attributes": {    "address": {      "street": "20 Ingram St",      "street2": "Apt #10",      "city": "Forest Hills",      "state": "NY",      "postalCode": "11375",      "country": "US"    },    "dateOfBirth": "1990-04-05",    "email": "erlich@piedpiper.com",    "fullName": {      "first": "Erlich",      "last": "Bachman"    },    "phone": {      "countryCode": "1",      "number": "5555555555"    },    "ssn": "721074426",    "status": "Approved"  }}

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.
authorizedUsersArray of AuthorizedUserArray of authorized users. An authorized user is someone who can participate in the One Time Password (OTP) authentication process.
statusstringStatus of the customer, either Active, Archived. You can't do any write operations with Archived customers.
archiveReasonstringOptional. The reason the account was archived, can be one of Inactive, FraudACHActivity, FraudCardActivity, FraudCheckActivity, FraudApplicationHistory, FraudAccountActivity, FraudClientIdentified, `FraudLinkedToFraudulentCustomer,.
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"    },    "status": "Active",    "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", "Partnership" 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.
statusstringStatus of the customer, either Active or Archived. You can't do any write operations on an Archived customer.
archiveReasonstringOptional, only if the customer status is Archived. The reason the customer was archived, can be one of Inactive, FraudACHActivity, FraudCardActivity, FraudCheckActivity, FraudApplicationHistory, FraudAccountActivity, FraudClientIdentified, `FraudLinkedToFraudulentCustomer,.
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"        }      }    ],    "status": "Active",    "tags": {      "userId": "106a75e9-de77-4e25-9561-faffe59d7814"    }  },  "relationships": {    "org": {      "data": {        "type": "org",        "id": "1"      }    },    "application": {      "data": {        "type": "businessApplication",        "id": "1"      }    }  }}

TrustCustomer#

TrustCustomer is a JSON:API resource, describing the trust customer. Top-level fields:

FieldtypeDescription
idstringIdentifier of the trust resource.
typestringType of the resource, the value is always trustCustomer.
attributesJSON ObjectJSON object representing the trust 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 trust.
stateOfIncorporationstringTwo letters representing a US state.
revocabilityEither Revocable or IrrevocableWhether the trust can be changed or canceled after the trust document has been signed.
sourceOfFundsOne of Inheritance, Salary, Savings, InvestmentReturns, GiftsOrigin of the funds used to fund the account.
taxIdstringThe grantor's SSN.
contactTrustContactPrimary contact of the trust.
authorizedUsersArray of AuthorizedUserArray of authorized users. An authorized user is someone who can participate in the One Time Password (OTP) authentication process.
statusstringStatus of the customer, either Active or Archived. You can't do any write operations on an Archived customer.
archiveReasonstringOptional, only if the customer status is Archived. The reason the account was archived, can be one of Inactive, FraudACHActivity, FraudCardActivity, FraudCheckActivity, FraudApplicationHistory, FraudAccountActivity, FraudClientIdentified, 'FraudLinkedToFraudulentCustomer'.
tagsobjectSee Tags. Inherited from the application tags (see Tag Inheritance).

Relationships#

NameTypeDescription
orgJSON:API RelationshipThe Org of the trust.
applicationJSON:API RelationshipThe Application that created this trust.
Example TrustCustomer resource:
{  "type": "trustCustomer",  "id": "52",  "attributes": {    "createdAt": "2022-04-02T22:14:28.574Z",    "name": "Trust me Inc.",    "stateOfIncorporation": "CA",    "revocability": "Revocable",    "sourceOfFunds": "Salary",    "taxId": "123456789",    "tags": {      "test": "test1"    },    "authorizedUsers": [      {        "fullName": {          "first": "Richard",          "last": "Hendricks"        },        "email": "richard@piedpiper.com",        "phone": {          "countryCode": "1",          "number": "2025550108"        }      }    ],    "status": "Active",    "contact": {      "fullName": {        "first": "Jared",        "last": "Dunn"      },      "email": "jared@piedpiper.com",      "phone": {        "countryCode": "1",        "number": "2025550108"      },      "address": {        "street": "5230 Newell Rd",        "city": "Palo Alto",        "state": "CA",        "postalCode": "94303",        "country": "US"      }    }  },  "relationships": {    "application": {      "data": {        "type": "application",        "id": "51"      }    },    "org": {      "data": {        "type": "org",        "id": "1"      }    }  }}

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.
updatedAtRFC3339 Date stringOptional. The date the resource was updated.
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). The balance represents the funds that are currently in the account (not taking into account future commitments). The balance equals the sum of 'available' and 'hold'.
holdintegerThe hold amount (in cents). The hold represents funds that are not available for spending, due to an outstanding card authorization.
availableintegerThe available balance for spending (in cents). Equals the balance minus the hold amount.
tagsobjectSee Tags.
statusstringStatus of the account, either Open, Frozen, or Closed.
freezeReasonstringOptional. The reason the account was frozen, either Fraud or free-text description.
closeReasonstringOptional. The reason the account was closed, either ByCustomer or Fraud.
fraudReasonstringOptional. The expanded fraud reason for closing the account when Fraud is specified as the reason. Can be one of: (ACHActivity, CardActivity, CheckActivity, ApplicationHistory, AccountActivity, ClientIdentified, IdentityTheft, LinkedToFraudulentCustomer).
dacaStatusstringOptional. The account DACA (Deposit Account Control Agreements) status. Can be one of: Entered, Activated.
note

The currency is currently always set to USD. The balance, hold and available amounts are represented in cents.

Relationships#

NameTypeDescription
customerOptional, populated if account has a single owner. JSON:API RelationshipThe customer.
customersOptional, populated if account has
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"      }    }  }}

CreditAccount#

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

FieldtypeDescription
idstringIdentifier of the credit account resource.
typestringType of the resource. Currently only creditAccount is supported.
attributesJSON ObjectJSON object representing the credit account data.
relationshipsJSON:API RelationshipsDescribes relationships between the credit account resource and the customer.

Attributes#

NameTypeDescription
createdAtRFC3339 Date stringThe date the resource was created.
updatedAtRFC3339 Date stringOptional. The date the resource was updated.
namestringName of the account holder.
creditTermsstringThe selected credit terms.
currencystringCurrency of the account.
creditLimitintegerThe credit limit (cents).
balanceintegerThe balance amount (cents). The balance represents the funds that are currently in the account (not taking into account future commitments). The balance equals the sum of settled transactions minus any repayments.
holdintegerThe hold amount (cents). The hold represents funds that are not available for spending, due to an outstanding card authorization.
availableintegerThe available balance for spending (cents). Equals the credit limit, minus the balance and hold amounts.
tagsobjectSee Tags.
statusstringStatus of the account, either Open, Frozen, or Closed.
freezeReasonstringOptional. The reason the account was frozen, either Fraud or free-text description.
closeReasonstringOptional. The reason the account was closed, either ByCustomer, Overdue or Fraud.
closeReasonTextstringOptional. An expanded free-text reason for account closure.
fraudReasonstringOptional. The expanded fraud reason for closing the account when Fraud is specified as the reason. Can be one of: (ACHActivity, CardActivity, CheckActivity, ApplicationHistory, AccountActivity, ClientIdentified, IdentityTheft, LinkedToFraudulentCustomer).
note

The currency is currently always set to USD. The balance, hold and available amounts are represented in cents.

Relationships#

NameTypeDescription
customerOptional, populated if account has a single owner. JSON:API RelationshipThe customer.
Example CreditAccount Resource:
{  "data": {    "type": "creditAccount",    "id": "42",    "attributes": {      "createdAt": "2000-05-11T10:19:30.409Z",      "name": "Peter Parker",      "status": "Open",      "creditTerms": "credit_terms_1",      "currency": "USD",      "balance": 10000,      "hold": 0,      "available": 10000,      "tags": {        "purpose": "some_purpose"      },      "creditLimit": 200000    },    "relationships": {      "customer": {        "data": {          "type": "customer",          "id": "45555"        }      },      "org": {        "data": {          "type": "org",          "id": "1"        }      }    }  }}

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.
updatedAtRFC3339 Date stringOptional. The date the resource was updated.
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.
updatedAtRFC3339 Date stringOptional. The date the resource was updated.
last4DigitsstringLast 4 digits of the debit card.
expirationDatestringCard expiration date, formatted YYYY-MM, e.g "2020-05".
shippingAddressAddressOptional. Shipping address, if specified.
ssnstringOptional. SSN of the card holder (numbers only), if specified during card creation.
passportstringOptional. Passport number of the card holder, if specified during card creation.
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.
updatedAtRFC3339 Date stringOptional. The date the resource was updated.
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.
updatedAtRFC3339 Date stringOptional. The date the resource was updated.
last4DigitsstringLast 4 digits of the debit card.
expirationDatestringCard expiration date, formatted YYYY-MM, e.g "2020-05".
ssnstringOptional. SSN of the card holder (numbers only), if specified during card creation.
passportstringOptional. Passport number of the card holder, if specified during card creation.
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"      }    }  }}

Counterparty Balance#

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

FieldtypeDescription
idstringIdentifier of the Counterparty.
typestringType of the balance. for counterparty balance the value is always counterpartyBalance.
attributesJSON ObjectJSON object representing the counterparty balance resource.
relationshipsJSON:API RelationshipsDescribes relationships between the counterparty balance and the customer and counterparty.

Attributes#

NameTypeDescription
balancenumberThe current balance amount (in cents) of the counterparty.
availablenumberOptional. The available balance amount (in cents) of the counterparty.

Relationships#

NameTypeDescription
counterpartyJSON:API RelationshipThe counterparty the balance belongs to.
customerJSON:API RelationshipThe customer the counterparty belongs to.
Example Counterparty Balance resource:
{  "data": {    "type": "counterpartyBalance",    "id": "2",    "attributes": {      "balance": 11000,      "available": 10000    },    "relationships": {      "counterparty": {        "data": {          "type": "counterparty",          "id": "2"        }      },      "customer": {        "data": {          "type": "customer",          "id": "10000"        }      }    }  }}

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,Pending Review, Rejected, Clearing, Sent, Canceled, Returned. See ACH Status.
reasonstringOptional. 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.
amountintegerThe amount (cents) of the payment.
settlementDateRFC3339 Date stringOptional, For ACH debit with statuses Pending,Clearing, shows the date on which the payment will be settled.
expectedCompletionDateRFC3339 Date stringOptional, For ACH credit with statuses Pending,Sent, shows the date on which the counterparty will handle the request.
tagsobjectSee Tags.
counterpartyVerificationMethodstringOptional, shows the verification method of the counterparty : 'Plaid'.
sameDaybooleanIndicates whether the payment is a Same Day ACH payment. See Same Day ACH.
secCodestringThe 3-letter ACH Standard Entry Class (SEC) Code. One of WEB, CCD, PPD.

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.
transactionJSON:API RelationshipOptional. The transaction generated by this payment. Generated instantly in cases where a credit ach payment is converted to a book payment, otherwise, once the payment is sent.
recurringPaymentOptional, JSON:API RelationshipThe recurring payment belonging to this payment.
Example AchPayment resource:
{  "data": {    "type": "achPayment",    "id": "50",    "attributes": {      "createdAt": "2020-01-13T16:01:19.346Z",      "status": "Pending",      "counterparty": {        "routingNumber": "812345678",        "accountNumber": "12345569",        "accountType": "Checking",        "name": "Jane Doe"      },      "description": "Funding",      "direction": "Credit",      "amount": 10000,      "sameDay": false,      "secCode": "WEB"    },    "relationships": {      "account": {        "data": {          "type": "depositAccount",          "id": "555"        }      },      "customer": {        "data": {          "type": "individualCustomer",          "id": "99823"        }      },      "counterparty": {        "data": {          "type": "counterparty",          "id": "4567"        }      },      "transaction": {        "data": {          "type": "transaction",          "id": "4003"        }      }    }  }}

Recurring Credit ACH Payment#

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

FieldtypeDescription
idstringIdentifier of the recurring Credit ACH payment resource.
typestringType of the payment resource. For credit ach recurring payments the value is recurringCreditAchPayment.
attributesJSON ObjectJSON object representing the recurring payment resource.
relationshipsJSON:API RelationshipsDescribes relationships between the Recurring Credit ACH payment and the originating deposit account and org.

Attributes#

NameTypeDescription
createdAtRFC3339 Date stringThe date the resource was created.
updatedAtRFC3339 Date stringThe date the resource was updated.
amountintegerThe amount (cents) of the payment.
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.
statusstringStatus of the recurring payment, one of: Active, Completed, Disabled.
numberOfPaymentsintegerRepresents the number of payments that were created by this recurring payment.
scheduleScheduleThe schedule of the recurring payment.
tagsobjectSee Tags.

Relationships#

NameTypeDescription
accountJSON:API RelationshipThe Deposit Account originating the recurring payment.
orgJSON:API RelationshipThe org the customer 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.
counterpartyJSON:API RelationshipThe Counterparty the payment to be made to.
Example RecurringCreditAchPayment resource:
{  "data": {    "type": "recurringCreditAchPayment",    "id": "1",    "attributes": {      "createdAt": "2022-06-25T08:50:49.391Z",      "updatedAt": "2022-06-25T08:50:49.391Z",      "amount": 1000,      "description": "Rent - Apartment 15",      "schedule": {        "startTime": "2022-06-25",        "interval": "Monthly",        "nextScheduledAction": "2022-07-18",        "dayOfMonth": 16      },      "status": "Active",      "numberOfPayments": 0    },    "relationships": {      "counterparty": {        "data": {          "type": "counterparty",          "id": "1"        }      },      "account": {        "data": {          "type": "account",          "id": "10002"        }      },      "customer": {        "data": {          "type": "customer",          "id": "10004"        }      },      "org": {        "data": {          "type": "org",          "id": "1"        }      }    }  }}

Book 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 Book 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).
reasonstringOptional. More information about the status.
directionstringThe direction in which the funds flow (either Debit or Credit).
descriptionstringPayment description (maximum of 80 characters), this will show up on statement of the counterparty.
transactionSummaryOverridestringIf this field is populated, its contents will be returned as the bookTransaction’s summary field (maximum of 100 characters).
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.
recurringPaymentOptional, JSON:API RelationshipThe recurring payment belonging to 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"        }      }    }  }}

Recurring Credit Book Payment#

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

FieldtypeDescription
idstringIdentifier of the recurring credit book payment resource.
typestringType of the payment resource. The value is always recurringCreditBookPayment.
attributesJSON ObjectJSON object representing the payment resource.
relationshipsJSON:API RelationshipsDescribes relationships between the recurring credit book payment and the originating deposit account and org.

Attributes#

NameTypeDescription
createdAtRFC3339 Date stringThe date the resource was created.
updatedAtRFC3339 Date stringThe date the resource was updated.
amountstringThe amount (cents) of the payment.
descriptionstringPayment description (maximum of 80 characters), this will show up on statement of the counterparty.
statusstringStatus of the recurring payment, one of: Active, Completed, Disabled.
numberOfPaymentsintegerRepresents the number of payments that were created by this recurring payment.
scheduleScheduleThe schedule of the recurring payment.
transactionSummaryOverridestringIf this field is populated, its contents will be returned as the bookTransaction’s summary field (maximum of 100 characters).
tagsobjectSee Tags.

Relationships#

NameTypeDescription
accountJSON:API RelationshipThe Deposit Account creating the recurring payment.
counterpartyAccountJSON:API RelationshipThe Counterparty account the payment to be made to.
orgJSON:API RelationshipThe org the customer 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.
Example RecurringBookPayment resource:
{  "data": {    "type": "recurringCreditBookPayment",    "id": "4",    "attributes": {      "createdAt": "2022-06-25T14:27:41.093Z",      "updatedAt": "2022-06-25T14:27:41.093Z",      "amount": 40,      "description": "Subscription - Basic Plan",      "schedule": {        "startTime": "2022-06-25",        "interval": "Monthly",        "nextScheduledAction": "2022-07-05",        "dayOfMonth": 5      },      "status": "Active",      "tags": {        "test": "test"      },      "numberOfPayments": 0    },    "relationships": {      "org": {        "data": {          "type": "org",          "id": "1"        }      },      "account": {        "data": {          "type": "account",          "id": "10002"        }      },      "counterpartyAccount": {        "data": {          "type": "account",          "id": "10000"        }      },      "customer": {        "data": {          "type": "customer",          "id": "10004"        }      }    }  }}

Wire 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, Returned, Sent or Rejected (see reason for details).
reasonstringOptional. 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.
imadOmadobject(Conditional) IMAD/OMAD - Input/Output Message Accountability Data. It's a unique number given to each FedWire payment in case of payment has been sent and fully processed.

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:
{  "data": {    "type": "wirePayment",    "id": "3",    "attributes": {      "createdAt": "2021-10-05T06:33:45.035Z",      "amount": 200,      "direction": "Credit",      "description": "Wire payment",      "counterparty": {        "name": "April Oniel",        "routingNumber": "812345678",        "accountNumber": "1000000001",        "address": {          "street": "20 Ingram St",          "city": "Forest Hills",          "state": "CA",          "postalCode": "11375",          "country": "US"        }      },      "status": "Sent",      "imadOmad": {        "imad": "123456",        "omad": "654321"      }    },    "relationships": {      "account": {        "data": {          "type": "account",          "id": "10000"        }      },      "customer": {        "data": {          "type": "customer",          "id": "10000"        }      },      "customers": {        "data": [          {            "type": "customer",            "id": "10000"          }        ]      },      "transaction": {        "data": {          "type": "transaction",          "id": "1"        }      }    }  }}

Bill Payment#

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

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

Attributes#

NameTypeDescription
createdAtRFC3339 Date stringThe date the resource was created.
statusstringEither Sent, Pending or Rejected (see reason for details).
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.
amountnumberThe 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, butisness 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 BillPay Transaction generated by this payment.
Example BillPayment resource
{  "data": {    "type": "billPayment",    "id": "6345",    "attributes": {      "createdAt": "2021-08-17T12:20:45.040Z",      "amount": 2400,      "direction": "Credit",      "description": "Water Bill payment June",      "status": "Pending"    },    "relationships": {      "account": {        "data": {          "type": "account",          "id": "95032"        }      },      "customer": {        "data": {          "type": "customer",          "id": "55332"        }      }    }  }}

ACH Received Payment#

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

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

Attributes#

FieldtypeDescription
createdAtRFC3339 Date stringThe date the transaction was created. Common to all receive payment types.
statusstringThe status of the Received Payment. One of Pending, Advanced, Completed or Returned, see ReceivedPayment Statuses. Common to all received payment types.
wasAdvancedbooleanWill be true if the received payment was or is being Advanced (has or has had the status Advanced). Common to all received payment types.
completionDateRFC3339 Date stringShows the date on which the received ACH will be completed(settled or repaid).
returnReasonstringOptional. The reason if the received payment is Returned. See ACH return reasons.
amountintegerThe amount (cents) of the ACH received payment. Common to all received payment types.
descriptionstringACH description (maximum of 10 characters), also known as Company Entry 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 received 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, business or individual.
receivePaymentTransactionOptional, JSON:API RelationshipThe transaction of the received payment, created due to advance or when the ACH is processed.
paymentAdvanceTransactionOptional, JSON:API RelationshipThe transaction that funded the Advance from the provisional credit operating account, if the received payment was advanced.
repayPaymentAdvanceTransactionOptional, JSON:API RelationshipThe transaction that repaid the advance once the received payment is completed.
Example AchReceivedPayment resource:
{  "type": "achReceivedPayment",  "id": "1337",  "attributes": {    "createdAt": "2022-02-01T12:03:14.406Z",    "status": "Completed",    "wasAdvanced": true,    "amount": 100000,    "completionDate": "2022-01-23",    "companyName": "Uber",    "counterpartyRoutingNumber": "051402372",    "description": "Sandbox Transaction",    "traceNumber": "123456789123456",    "secCode": "PPD",    "tags": {}  },  "relationships": {    "account": {      "data": {        "type": "account",        "id": "163555"      }    },    "customer": {      "data": {        "type": "customer",        "id": "129522"      }    },    "receivePaymentTransaction": {      "data": {        "type": "transaction",        "id": "101"      }    },    "paymentAdvanceTransaction": {      "data": {        "type": "transaction",        "id": "202"      }    },    "repayPaymentAdvanceTransaction": {      "data": {        "type": "transaction",        "id": "890"      }    }  }}

Declined Incoming Payment#

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

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

Attributes#

NameTypeDescription
createdAtRFC3339 Date stringThe date the resource was created.
reasonstringThe reason for the transaction return. See ACH return reasons.
directionstringThe direction in which the funds flow (either Debit or Credit).
amountintegerThe amount (cents) of the payment.
typestringType of the payment resource.

Currently only AchPayment payment type is supported.

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.
Example DeclinedIncomingPayment resource:
{  "data": {    "type": "declinedIncomingPayment",    "id": "1",    "attributes": {      "direction": "Credit",      "amount": 10000,      "reason": "NoAccount",      "paymentType": "AchPayment",      "createdAt": "2020-01-13T16:01:19.346Z"    },    "relationships": {      "account": {        "data": {          "type": "account",          "id": "555"        }      },      "customer": {        "data": {          "type": "customer",          "id": "99823"        }      }    }  }}

ACH Repayment#

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

FieldtypeDescription
idstringIdentifier of the ACH repayment resource.
typestringType of the payment resource. For ach repayment the value is achRepayment.
attributesJSON ObjectJSON object representing the repayment resource.
relationshipsJSON:API RelationshipsDescribes relationships between the ACH repayment and the originating deposit account, credit account and org.

Attributes#

NameTypeDescription
createdAtRFC3339 Date stringThe date the resource was created.
updatedAtRFC3339 Date stringThe date the resource was updated.
amountintegerThe amount (cents) of the payment.
statusstringEither Pending, PendingReview, Returned, Sent or Rejected
tagsobjectSee Tags.

Relationships#

NameTypeDescription
accountJSON:API RelationshipThe Deposit Account originating the repayment.
creditAccountJSON:API RelationshipThe Credit Account the repayment is made for.
orgJSON:API RelationshipThe org the customer 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.
counterpartyJSON:API RelationshipThe Counterparty the repayment to be made from.
paymentJSON:API RelationshipThe payment created between the account and the counterparty
Example AchRepayment resource:
{  "data": {    "type": "achRepayment",    "id": "1",    "attributes": {      "createdAt": "2022-09-19T09:02:13.343Z",      "updatedAt": "2022-09-19T09:02:13.343Z",      "amount": 200,      "status": "Pending"    },    "relationships": {      "org": {        "data": {          "type": "org",          "id": "1"        }      },      "account": {        "data": {          "type": "account",          "id": "10003"        }      },      "counterparty": {        "data": {          "type": "counterparty",          "id": "1"        }      },      "creditAccount": {        "data": {          "type": "creditAccount",          "id": "10007"        }      },      "customer": {        "data": {          "type": "customer",          "id": "10002"        }      },      "payment": {        "data": {          "type": "payment",          "id": "1"        }      }    }  }}

Book Repayment#

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

FieldtypeDescription
idstringIdentifier of the Book repayment resource.
typestringType of the payment resource. For book repayment the value is bookRepayment.
attributesJSON ObjectJSON object representing book repayment resource.
relationshipsJSON:API RelationshipsDescribes relationships between the book repayment and the originating deposit account, credit account and org.

Attributes#

NameTypeDescription
createdAtRFC3339 Date stringThe date the resource was created.
updatedAtRFC3339 Date stringThe date the resource was updated.
amountintegerThe amount (cents) of the payment.
statusstringEither Pending, PendingReview, Returned, Sent or Rejected
tagsobjectSee Tags.

Relationships#

NameTypeDescription
accountJSON:API RelationshipThe Deposit Account originating the repayment.
creditAccountJSON:API RelationshipThe Credit Account the repayment is made for.
orgJSON:API RelationshipThe org the customer 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.
counterpartyAccountJSON:API RelationshipThe Deposit Account the repayment to be made from.
paymentJSON:API RelationshipThe payment created between the account and counterpartyAccount
Example BookRepayment resource:
{  "data": {    "type": "bookRepayment",    "id": "5",    "attributes": {      "createdAt": "2022-09-19T09:33:16.254Z",      "updatedAt": "2022-09-19T09:33:16.254Z",      "amount": 20,      "status": "Sent"    },    "relationships": {      "counterparty": {        "data": {          "type": "account",          "id": "10008"        }      },      "account": {        "data": {          "type": "account",          "id": "10006"        }      },      "creditAccount": {        "data": {          "type": "creditAccount",          "id": "10007"        }      },      "customer": {        "data": {          "type": "customer",          "id": "10002"        }      },      "org": {        "data": {          "type": "org",          "id": "2"        }      },      "payment": {        "data": {          "type": "payment",          "id": "6"        }      }    }  }}

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.
addendastringOptional, additional transaction description.
counterpartyCounterpartyThe party on the other end of the transaction.
secCodestringThe 3-letter ACH Standard Entry Class (SEC) Code. One of WEB, CCD, PPD.
traceNumberstringOptional. The 15-digit ACH Trace Number identifies the transaction within the ACH file after transmission.
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.
recurringPaymentOptional, JSON:API RelationshipThe recurring 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": "Unit Inc | Initial account funding",    "description": "Funding",    "addenda": "Initial account funding",    "counterparty": {      "name": "Unit Inc",      "routingNumber": "812345678",      "accountNumber": "1",      "accountType": "Checking"    },    "secCode": "WEB",    "traceNumber": "812345670000123"  },  "relationships": {    "account": {      "data": {        "type": "account",        "id": "10001"      }    },    "customer": {      "data": {        "type": "customer",        "id": "3"      }    },    "payment": {      "data": {        "type": "payment",        "id": "5"      }    }  }}

Received ACH 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 represents a received ACH that has been returned, automatically by Unit (e.g insufficient funds), by a dispute, or manually via a Return Received ACH.

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

FieldtypeDescription
idstringIdentifier of the transaction resource.
typestringType of the transaction resource. The value is always returnedReceivedAchTransaction.
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: Account has insufficient funds",    "companyName": "John Doe",    "reason": "InsufficientFunds"  },  "relationships": {    "account": {      "data": {        "type": "account",        "id": "1"      }    },    "customer": {      "data": {        "type": "customer",        "id": "3"      }    },    "returned": {      "data": {        "type": "transaction",        "id": "55"      }    }  }}

Dishonored ACH Transaction#

A dishonored ACH transaction is a relatively uncommon transaction type, that happens when Unit attempts to return a received ACH, but the originating bank decides not to return the funds. This typically happens when the return is not in compliance with the NACHA rules (e.g. 3 days after the payment took place when the network rules define a maximum of 2 days).

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

FieldtypeDescription
idstringIdentifier of the transaction resource.
typestringType of the transaction resource. The value is always dishonoredAchTransaction.
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).

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.
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.
counterpartyAccountJSON:API RelationshipThe account of the counterparty.
counterpartyCustomerJSON:API RelationshipThe counterparty customer.
paymentOptional, JSON:API RelationshipThe payment belonging to this transaction.
recurringPaymentOptional, JSON:API RelationshipThe recurring payment belonging to this transaction.
Example BookTransaction resource:
{  "type": "bookTransaction",  "id": "9547",  "attributes": {    "createdAt": "2020-07-05T15:49:36.864Z",    "direction": "Credit",    "amount": 1000,    "balance": 12000,    "summary": "Counterparty: Jane Smith | Description: Gift",    "counterparty": {      "name": "Jane Smith",      "routingNumber": "812345678",      "accountNumber": "10039",      "accountType": "Checking"    }  },  "relationships": {    "account": {      "data": {        "type": "depositAccount",        "id": "10035"      }    },    "customer": {      "data": {        "type": "customer",        "id": "5"      }    },    "counterpartyAccount": {      "data": {        "type": "account",        "id": "10036"      }    },    "counterpartyCustomer": {      "data": {        "type": "customer",        "id": "7"      }    },    "payment": {      "data": {        "type": "payment",        "id": "10000"      }    }  }}

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.
merchant.idstringOptional. The unique network merchant identifier.
coordinatesCoordinatesOptional. Coordinates (latitude, longitude) of where the purchase took place.
recurringbooleanIndicates whether the transaction is recurring.
interchangestringOptional. The interchange share for this transaction. Calculated at the end of each day, see the transaction.updated event.
ecommercebooleanIndicates whether the transaction was created over an electronic network (primarily the internet).
cardPresentbooleanIndicates whether the card was present when the transaction was created.
paymentMethodstringOptional. The payment method used, one of: Manual, Swipe, Contactless, ChipAndPin, Stored, Other.
digitalWalletstringOptional. The type of digital wallet used, one of: Google, Apple, Other.
cardVerificationData.verificationMethodstringOptional. The verification method used, one of: Address, CVV2, AddressAndCVV2.
cardNetworkstringOptional. The card network used, one of: Visa, Interlink, Accel, Allpoint, Other.
tagsobjectSee Tags. Inherited from the authorization request tags (see Tag Inheritance).
cashWithdrawalAmountintegerOptional. Cash withdrawal amount

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).
authorizationRequestOptional, JSON:API RelationshipThe preceding authorization request, if present (see Authorization Requests).
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",      "id": "029859000085093"    },    "coordinates": {      "longitude": -77.0364,      "latitude": 38.8951    },    "recurring": false,    "interchange": "2.43",    "ecommerce": false,    "cardPresent": true,    "paymentMethod": "Contactless",    "digitalWallet": "Apple",    "cardVerificationData": {      "verificationMethod": "CVV2"    },    "cardNetwork": "Visa"  },  "relationships": {    "account": {      "data": {        "type": "account",        "id": "10001"      }    },    "customer": {      "data": {        "type": "customer",        "id": "3"      }    },    "card": {      "data": {        "type": "card",        "id": "11"      }    },    "authorization": {      "data": {        "type": "authorization",        "id": "40"      }    }  }}

ATM 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.
interchangestringOptional. The interchange share for this transaction. Calculated at the end of each day, see the transaction.updated event.
cardNetworkstringOptional. The card network used, one of: Visa, Interlink, Accel, Allpoint, Other.
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,    "cardNetwork": "Allpoint"  },  "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"      }    }  }}

Negative Balance Coverage Transaction#

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

FieldtypeDescription
idstringIdentifier of the transaction resource.
typestringType of the transaction resource. The value is always negativeBalanceCoverageTransaction.
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.
Example NegativeBalanceCoverageTransaction resource:
{  "type": "negativeBalanceCoverageTransaction",  "id": "97",  "attributes": {    "createdAt": "2022-07-18T13:56:05.385Z",    "amount": 2005,    "direction": "Credit",    "balance": 0,    "summary": "Negative balance coverage of account 10014"  },  "relationships": {    "account": {      "data": {        "type": "account",        "id": "10014"      }    },    "customer": {      "data": {        "type": "customer",        "id": "10009"      }    },    "customers": {      "data": [        {          "type": "customer",          "id": "10009"        }      ]    }  }}

Card Reversal 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#

A transaction that represents various card transactions that are not Purchase or ATM transactions. Most commonly, these transactions represent peer-to-peer payments (e.g. Venmo, CashApp) and gig economy employee payouts (ride sharing, deliveries, etc).

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

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.
merchant.namestringOptional. The name of the merchant.
merchant.typeintegerOptional. The 4-digit ISO 18245 merchant category code (MCC).
merchant.categorystringOptional. The 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.
merchant.idstringOptional. The unique network merchant identifier.
recurringbooleanOptional. Indicates whether the transaction is recurring.
interchangestringOptional. The interchange share for this transaction. Calculated at the end of each day, see the transaction.updated event.
paymentMethodstringOptional. The payment method used, one of: Manual, Swipe, Contactless, ChipAndPin, Stored, Other.
digitalWalletstringOptional. The type of digital wallet used, one of: Google, Apple, Other.
cardVerificationData.verificationMethodstringOptional. The verification method used, one of: Address, CVV2, AddressAndCVV2.
cardNetworkstringOptional. The card network used, one of: Visa, Interlink, Accel, Allpoint, Other.
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 used in the purchase.
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",    "merchant": {      "name": "Europcar Mobility Group",      "type": 3381,      "category": "EUROP CAR",      "location": "Cupertino, CA",      "id": "029859000085093"    },    "recurring": false,    "interchange": "2.43",    "paymentMethod": "Contactless",    "digitalWallet": "Apple",    "cardVerificationData": {      "verificationMethod": "CVV2"    },    "cardNetwork": "Visa"  },  "relationships": {    "account": {      "data": {        "type": "account",        "id": "10001"      }    },    "customer": {      "data": {        "type": "customer",        "id": "1001"      }    },    "card": {      "data": {        "type": "card",        "id": "11"      }    }  }}

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.
Attributes
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.
originatorToBeneficiaryInformationstringOriginator To Beneficiary Information, multi-line string delimited by \n.
senderReferencestringSender reference.
referenceForBeneficiarystringReference for the Beneficiary.
beneficiaryInformationstringBeneficiary Information, multi-line string delimited by \n.
beneficiaryAdviceInformationstringBeneficiary Advice Information, multi-line string delimited by \n.
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 to Jane Smith",    "counterparty": {      "name": "Jane Smith",      "routingNumber": "812345678",      "accountNumber": "10039",      "accountType": "Checking"    }  },  "relationships": {    "account": {      "data": {        "type": "depositAccount",        "id": "10035"      }    },    "customer": {      "data": {        "type": "customer",        "id": "5"      }    }  }}

Release 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"      }    }  }}

Interest Share Transaction#

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

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

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.
orgJSON:API RelationshipThe Org of the customer.
Example InterestShareTransaction resource:
{  "data": {    "type": "interestShareTransaction",    "id": "12345",    "attributes": {      "createdAt": "2021-09-01T04:08:33.250Z",      "amount": 1,      "direction": "Credit",      "balance": 7,      "summary": "Interest Share August 2021"    },    "relationships": {      "account": {        "data": {          "type": "account",          "id": "1"        }      },      "customer": {        "data": {          "type": "customer",          "id": "24"        }      },      "customers": {        "data": [          {            "type": "customer",            "id": "24"          }        ]      },      "org": {        "data": {          "type": "org",          "id": "1"        }      }    }  }}

Dispute 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, disputedTransaction).

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.
disputedTransactionOptional, JSON:API RelationshipThe transaction that has been disputed.
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"      }    },    "disputedTransaction": {      "data": {        "type": "transaction",        "id": "6"      }    }  }}

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"        }      }    }  }}

Payment Canceled Transaction#

The transaction represents an originated ACH that has been canceled by its originator prior to its transmission to the ACH network.

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

FieldtypeDescription
idstringIdentifier of the transaction resource.
typestringType of the transaction resource. The value is always paymentCanceledTransaction.
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.
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.
orgJSON:API RelationshipThe org the customer belongs to.
relatedTransactionJSON:API RelationshipThe original transaction being canceled.
Example PaymentCanceledTransaction resource:
{  "type": "paymentCanceledTransaction",  "id": "185",  "attributes": {    "createdAt": "2022-02-02T13:11:22.404Z",    "amount": 7000,    "direction": "Credit",    "balance": 1702108,    "summary": "Cancellation of: 184  |  Payment Id: 18"  },  "relationships": {    "account": {      "data": {        "type": "account",        "id": "10002"      }    },    "customer": {      "data": {        "type": "customer",        "id": "10001"      }    },    "customers": {      "data": [        {          "type": "customer",          "id": "10001"        }      ]    },    "relatedTransaction": {      "data": {        "type": "transaction",        "id": "184"      }    }  }}

Payment Advance Transaction#

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

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

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. The value is always Debit.
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.
receivedPaymentJSON:API RelationshipThe ReceivedPayment that was advanced and funded with this transaction.
Example PaymentAdvanceTransaction resource:
{  "type": "paymentAdvanceTransaction",  "id": "226",  "attributes": {    "createdAt": "2021-04-19T12:44:08.055Z",    "amount": 2500,    "direction": "Debit",    "balance": 550000,    "summary": "Advance for ReceivedPayment with id 6",    "tags": {      "trackingId": "106a75e9-de77-4e25-9561-faffe59d7814"    }  },  "relationships": {    "account": {      "data": {        "type": "account",        "id": "10001"      }    },    "customer": {      "data": {        "type": "customer",        "id": "10000"      },      "receivedPayment": {        "data": {          "type": "receivedPayment",          "id": "6"        }      }    }  }}

Repaid Payment Advance Transaction#

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

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

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. The value is always Credit.
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.
receivedPaymentJSON:API RelationshipThe ReceivedPayment that was previously advanced and now completed (and repaid) .
paymentAdvanceTransactionJSON:API RelationshipThe transaction that Debit the account for the advance that this repayment is related to.
Example RepaidPaymentAdvanceTransaction resource:
{  "type": "repaidPaymentAdvanceTransaction",  "id": "226",  "attributes": {    "createdAt": "2021-04-19T12:44:08.055Z",    "amount": 2500,    "direction": "Credit",    "balance": 550000,    "summary": "Repayment for Advance Transaction with id 101 of ReceivedPayment with id 6",    "tags": {      "trackingId": "106a75e9-de77-4e25-9561-faffe59d7814"    }  },  "relationships": {    "account": {      "data": {        "type": "account",        "id": "10001"      }    },    "customer": {      "data": {        "type": "customer",        "id": "10000"      },      "receivedPayment": {        "data": {          "type": "receivedPayment",          "id": "6"        }      },      "paymentAdvanceTransaction": {        "data": {          "type": "transaction",          "id": "101"        }      }    }  }}

Chargeback Transaction#

chargebackTransaction is a type of transaction that is generated when a Chargeback request is initiated.

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

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

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, this will be the description of the chargeback.
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.
counterpartyAccountJSON:API RelationshipThe account of the counterparty.
chargebackJSON:API RelationshipThe chargeback belonging to this transaction.
Example ChargebackTransaction resource:
{  "type": "chargebackTransaction",  "id": "9547",  "attributes": {    "createdAt": "2020-07-05T15:49:36.864Z",    "direction": "Debit",    "amount": 1000,    "balance": 12000,    "summary": "Chargeback for dispute #1337",    "counterparty": {      "name": "Jane Smith",      "routingNumber": "812345678",      "accountNumber": "10039",      "accountType": "Checking"    },    "tags": {      "internalId": "abc1345"    }  },  "relationships": {    "account": {      "data": {        "type": "account",        "id": "10035"      }    },    "customer": {      "data": {        "type": "customer",        "id": "10000"      }    },    "customers": {      "data": [        {          "type": "customer",          "id": "10000"        }      ]    },    "counterpartyAccount": {      "data": {        "type": "account",        "id": "10036"      }    },    "chargeback": {      "data": {        "type": "chargeback",        "id": "10530"      }    }  }}

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.
statusstringOne of Authorized, Completed, Canceled, Declined, see Authorization Statuses.
declineReasonstringOptional. The reason the authorization was declined. 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.
merchant.idstringOptional. The unique network merchant identifier.
recurringbooleanIndicates whether the authorization is recurring
paymentMethodstringOptional. The payment method used, one of: Manual, Swipe, Contactless, ChipAndPin, Stored, Other.
digitalWalletstringOptional. The type of digital wallet used, one of: Google, Apple, Other.
cardVerificationData.verificationMethodstringOptional. The verification method used, one of: Address, CVV2, AddressAndCVV2.
cardNetworkstringOptional. The card network used, one of: Visa, Interlink, Accel, Allpoint, Other.
tagsobjectSee Tags. Inherited from the authorization request tags (see Tag Inheritance).
cashWithdrawalAmountintegerOptional. Cash withdrawal amount

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.
authorizationRequestOptional, JSON:API RelationshipThe preceding authorization request, if present (see Authorization Requests).
Example Authorization resource:
{  "type": "authorization",  "id": "97",  "attributes": {    "createdAt": "2021-02-21T07:29:42.447Z",    "amount": 2000,    "cardLast4Digits": "0019",    "status": "Authorized",    "merchant": {      "name": "Europcar Mobility Group",      "type": 3381,      "category": "EUROP CAR",      "location": "Cupertino, CA",      "id": "029859000085093"    },    "recurring": false,    "paymentMethod": "Contactless",    "digitalWallet": "Apple",    "cardVerificationData": {      "verificationMethod": "CVV2"    },    "cardNetwork": "Visa"  },  "relationships": {    "customer": {      "data": {        "type": "customer",        "id": "10000"      }    },    "account": {      "data": {        "type": "account",        "id": "10001"      }    },    "card": {      "data": {        "type": "card",        "id": "10501"      }    }  }}

Purchase Authorization 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.
merchant.idstringOptional. The unique network merchant identifier.
recurringbooleanIndicates whether the authorization is recurring
ecommercebooleanOptional. Indicates whether the transaction was created over an electronic network (primarily the internet).
cardPresentbooleanOptional. Indicates whether the card was present when the transaction was created.
paymentMethodstringOptional. The payment method used, one of: Manual, Swipe, Contactless, ChipAndPin, Stored, Other.
digitalWalletstringOptional. The type of digital wallet used, one of: Google, Apple, Other.
cardVerificationData. verificationMethodstringOptional. The verification method used, one of: Address, CVV2, AddressAndCVV2.
cardNetworkstringOptional. The card network used, one of: Visa, Interlink, Accel, Allpoint, Other.
healthcareAmountsHealthcare AmountsOptional. IIAS related data for FSA/HRA enabled cards.
tagsobjectOptional, See Tags. If specified when approving the authorization request.
cashWithdrawalAmountintegerOptional. Cash withdrawal amount

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.
fundingAccountOptional, JSON:API RelationshipAn alternate Deposit Account that will be used for funding the transaction.
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",      "id": "311204598883"    },    "recurring": false,    "paymentMethod": "Contactless",    "digitalWallet": "Apple",    "cardVerificationData": {      "verificationMethod": "CVV2"    },    "ecommerce": true,    "cardPresent": false,    "cardNetwork": "Visa"  },  "relationships": {    "customer": {      "data": {        "type": "customer",        "id": "10000"      }    },    "account": {      "data": {        "type": "account",        "id": "10001"      }    },    "card": {      "data": {        "type": "card",        "id": "7"      }    }  }}

Card Transaction Authorization Request#

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

FieldtypeDescription
idstringIdentifier of the card transaction authorization request resource.
typestringType of the card transaction authorization request resource. The value is always cardTransactionAuthorizationRequest.
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.
merchant.idstringOptional. The unique network merchant identifier.
recurringbooleanIndicates whether the authorization is recurring
paymentMethodstringOptional. The payment method used, one of: Manual, Swipe, Contactless, ChipAndPin, Stored, Other.
digitalWalletstringOptional. The type of digital wallet used, one of: Google, Apple, Other.
cardVerificationData. verificationMethodstringOptional. The verification method used, one of: Address, CVV2, AddressAndCVV2.
cardNetworkstringOptional. The card network used, one of: Visa, Interlink, Accel, Allpoint, Other.
tagsobjectOptional, See Tags. If specified when approving the authorization request.

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 transaction.
fundingAccountOptional, JSON:API RelationshipAn alternate Deposit Account that will be used for funding the transaction.
Example CardTransactionAuthorizationRequest resource:
{  "type": "cardTransactionAuthorizationRequest",  "id": "1",  "attributes": {    "createdAt": "2021-06-22T13:39:17.018Z",    "amount": 2500,    "status": "Pending",    "partialApprovalAllowed": false,    "merchant": {      "name": "Apple Inc.",      "type": 1000,      "category": "",      "location": "Cupertino, CA",      "id": "311204598883"    },    "recurring": false,    "paymentMethod": "Contactless",    "digitalWallet": "Apple",    "cardVerificationData": {      "verificationMethod": "CVV2"    },    "cardNetwork": "Visa"  },  "relationships": {    "customer": {      "data": {        "type": "customer",        "id": "10000"      }    },    "account": {      "data": {        "type": "account",        "id": "10001"      }    },    "card": {      "data": {        "type": "card",        "id": "7"      }    }  }}

ATM Authorization Request#

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

FieldtypeDescription
idstringIdentifier of the authorization request resource.
typestringType of the authorization request resource. The value is always atmAuthorizationRequest.
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
directionstringThe direction in which the funds flow (either Debit or Credit).
atmNamestringThe name of the ATM.
atmLocationstringOptional. The location (city, state, etc.) of the ATM.
surchargenumberThe surcharge fee (cents) for the transaction.
internationalServiceFeenumberOptional. The fee (cents) for international transactions.
cardNetworkstringOptional. The card network used, one of: Visa, Interlink, Accel, Allpoint, Other.
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 used in the purchase.
Example AtmAuthorizationRequest resource:
{  "type": "atmAuthorizationRequest",  "id": "1",  "attributes": {    "createdAt": "2021-06-22T13:39:17.018Z",    "amount": 2500,    "status": "Pending",    "partialApprovalAllowed": false,    "direction": "Debit",    "atmName": "HOME FED SAV BK",    "atmLocation": "Cupertino, CA, US",    "surcharge": 0,    "internationalServiceFee": 0,    "cardNetwork": "Allpoint"  },  "relationships": {    "customer": {      "data": {        "type": "customer",        "id": "10000"      }    },    "account": {      "data": {        "type": "account",        "id": "10001"      }    },    "card": {      "data": {        "type": "card",        "id": "7"      }    }  }}

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"        }      }    }  }}

Chargeback#

This resource is generated as a result of a chargeback creation request.

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

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

Attributes#

NameTypeDescription
createdAtRFC3339 Date stringThe date the chargeback was created.
amountintegerThe amount (in cents) of the chargeback.
descriptionstringDescription of the chargeback.
tagsobjectSee Tags.

Relationships#

NameTypeDescription
accountJSON:API RelationshipThe Deposit Account the funds will be debited from.
customerJSON:API RelationshipThe Customer the deposit account belongs to.
counterpartyAccountJSON:API RelationshipThe account that will receive the funds.
transactionJSON:API RelationshipThe Chargeback Transaction generated by this chargeback.
Example Chargeback resource:
{  "type": "chargeback",  "id": "2",  "attributes": {    "createdAt": "2022-03-24T17:36:47.638Z",    "amount": 5000,    "description": "Chargeback for dispute #1337",    "tags": {      "internalId": "abc1345"    }  },  "relationships": {    "account": {      "data": {        "type": "account",        "id": "10006"      }    },    "customer":