Resources
Account End-Of-Day
Account End-Of-Day is a JSON:API resource, top-level fields:
id
string
Identifier of the account end-of-day resource.
type
string
Type of the account end-of-day resource. The value is always
accountEndOfDay.attributes
JSON Object
JSON object representing the account end-of-day data.
relationships
JSON:API Relationships
Describes relationships between the statement resource and other resources (account and customer).
Attributes
date
ISO Local Date string
The date the account end-of-day resource was created.
balance
integer
The balance amount (in cents). The balance equals thee sum of 'available' and 'hold'.
hold
integer
The hold amount (in cents). Not available for spending.
available
integer
The available balance for spending (in cents).
overdraftLimitOptional
integer
Optional. The overdraft limit amount.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example Account End-Of-Day resource:
{
"type": "accountEndOfDay",
"id": "4925158",
"attributes": {
"date": "2021-07-10",
"balance": 1000,
"available": 500,
"hold": 500
},
"relationships": {
"customer": {
"data": {
"type": "customer",
"id": "10000"
}
},
"account": {
"data": {
"type": "account",
"id": "30317"
}
}
}
}
Account Low Balance Closure Transaction
An accountLowBalanceClosureTransaction represents account low balance closure transaction.
AccountLowBalanceClosureTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
accountLowBalanceClosureTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (accounts, customer).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example 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"
}
}
}
}
}
AccountHold
AccountHold is a JSON:API resource, top-level fields:
id
string
Identifier of the account hold resource.
type
string
Type of the resource, the value is always
accountHold.attributes
JSON Object
JSON object representing the account hold data.
relationships
JSON:API Relationships
Describes relationships between the account hold resource and the account.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
status
string
Status of the account hold, either
Active, Released, PartiallyReleased.amount
integer
The amount (cents) of the payment.
remainingHoldAmount
integer
The remaining amount (cents) being held. Only present when status is
PartiallyReleased.expiredAtOptional
RFC3339 Date string
Optional. Date only (e.g.
"2001-08-15"). the date the account hold will be automatically released at.description
string
Account hold description (maximum of 80 characters).
Relationships
Example AccountHold Resource:
{
"data": {
"type": "accountHold",
"id": "7345432",
"attributes": {
"createdAt": "2024-10-02T12:39:25.107Z",
"expiredAt": "2024-10-10",
"status": "Active",
"amount": 4433,
"description": "Account Hold Reason 1"
},
"relationships": {
"account": {
"data": {
"type": "account",
"id": "158853345"
}
}
}
}
}
ACH Counterparty
Counterparty is a JSON:API resource, top-level fields:
id
string
Identifier of the ACH counterparty resource.
type
string
Type of the ACH counterparty resource.
attributes
JSON Object
JSON object representing the counterparty resource.
relationships
JSON:API Relationships
Describes relationships between the ACH counterparty and the originating customer.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
name
string
The account holder's name (whether an individual or a business).
bank
string
Name of the bank.
accountNumber
string
Bank account number.
accountType
string
Either
Checking, Savings or Loan.type
string
Either
Business, Person or Unknown.permissions
string
Either
CreditOnly or CreditAndDebit.Relationships
Example Counterparty 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:
id
string
Identifier of the ACH payment resource.
type
string
Type of the payment resource. For originations the value is
achPayment.attributes
JSON Object
JSON object representing the payment resource.
relationships
JSON:API Relationships
Describes relationships between the ACH payment and the originating deposit account and customer.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
status
string
reasonOptional
string
Optional. More information about the status.
direction
string
The direction in which the funds flow (either
Debit or Credit).description
string
Payment description (maximum of 10 characters), also known as Company Entry Description, this will show up on statement of the counterparty.
addendaOptional
string
Optional, additional payment description (maximum of 50 characters), not all institutions present that.
amount
integer
The amount (cents) of the payment.
settlementDateOptional
RFC3339 Date string
Optional, for ACH debit with statuses
Pending,Clearing, shows the date on which the payment will be settled.expectedCompletionDateOptional
RFC3339 Date string
Optional, for ACH credit with statuses
Pending,Sent, shows the date on which the counterparty will handle the request.counterpartyVerificationMethodOptional
string
Optional, shows the verification method of the counterparty : 'Plaid'.
secCode
string
The 3-letter ACH Standard Entry Class (SEC) Code. One of
WEB, CCD, PPD.Relationships
customer
OptionalJSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
transactionOptional
JSON:API Relationship
Optional. The transaction generated by this payment. Generated instantly in cases where a credit ach payment is converted to a book payment, otherwise, once the payment is sent.
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"
}
}
}
}
}
ACH Received Payment
AchReceivedPayment is a JSON:API resource, top-level fields:
id
string
Identifier of the received payment resource.
type
string
Type of the transaction resource. The value is always
achReceivedPayment.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account, customer related transactions).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all receive payment types.
status
string
The status of the Received Payment. One of
Pending, PendingReview, MarkedForReturn, Advanced, Completed or Returned, see ReceivedPayment Statuses. Common to all received payment types.wasAdvanced
boolean
Will be
true if the received payment was or is being Advanced (has or has had the status Advanced). Common to all received payment types.isAdvanceable
boolean
Will be
true if the received payment can be advanced.direction
string
The direction in which the funds flow (either
Debit or Credit).completionDate
RFC3339 Date string
Shows the date on which the received ACH will be completed(settled or repaid).
returnReasonOptional
string
Optional. The reason if the received payment is
Returned. See ACH return reasons.amount
integer
The amount (cents) of the ACH received payment. Common to all received payment types.
description
string
ACH description (maximum of 10 characters), also known as Company Entry Description.
addendaOptional
string
Optional. Additional transaction description (maximum of 80 characters).
companyName
string
The name by which the originator is known to the receiver.
originatorEntityIdOptional
string
Optional. A unique identifier by which the originator is formally recognized within the ACH network.
receivingEntityNameOptional
string
Optional. The name of the Recipient as it was declared by the originator of the payment.
counterpartyRoutingNumber
string
The routing number of the party that originated the received ACH payment.
traceNumber
string
The ACH Trace Number.
secCodeOptional
string
Optional. The 3-letter ACH Standard Entry Class (SEC) Code (e.g.
WEB, CCD, PPD, etc.).returnCutoffTimeOptional
RFC3339 Date string
Optional. The last time when a reprocess will be accepted. Will be the next banking day 2pm ET.
canBeReprocessedOptional
boolean
Optional. If set to
true, the Received Payment can be reprocessed until the returnCutoffTime. If empty, the Received Payments can't be reprocessed.Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to, business or individual.
receivePaymentTransaction
Optional, JSON:API Relationship
The transaction of the received payment, created due to advance or when the ACH is processed.
paymentAdvanceTransaction
Optional, JSON:API Relationship
The transaction that funded the Advance from the provisional credit operating account, if the received payment was advanced.
repayPaymentAdvanceTransaction
Optional, JSON:API Relationship
The transaction that repaid the advance once the received payment is completed.
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",
"returnCutoffTime": "2024-08-27T18:00:00.000Z",
"canBeReprocessed": "true",
"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"
}
}
}
}
Wire Received Payment
WireReceivedPayment is a JSON:API resource, top-level fields:
id
string
Identifier of the received payment resource.
type
string
Type of the transaction resource. The value is always
wireReceivedPayment.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account, customer related transactions).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all receive payment types.
status
string
The status of the Received Payment. One of
Pending, PendingReview, MarkedForReturn, Advanced, Completed or Returned, see ReceivedPayment Statuses. Common to all received payment types.direction
string
The direction in which the funds flow (Credit only).
returnReasonOptional
string
Optional. The reason if the received payment is
Returned.amount
integer
The amount (cents) of the wire received payment. Common to all received payment types.
description
string
Payment description (maximum of 50 characters).
counterparty
The party on the other end of the transaction, either the beneficiary or the originator.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to, business or individual.
receivePaymentTransaction
Optional, JSON:API Relationship
The transaction of the received payment, created when the wire is processed.
Example WireReceivedPayment resource:
{
"type": "wireReceivedPayment",
"id": "1338",
"attributes": {
"createdAt": "2022-02-01T12:03:14.406Z",
"status": "Completed",
"amount": 100000,
"direction": "Credit",
"description": "Wire payment from customer",
"counterparty": {
"name": "John Doe",
"routingNumber": "812345678",
"accountNumber": "10039",
"accountType": "Checking"
},
"tags": {}
},
"relationships": {
"account": {
"data": {
"type": "account",
"id": "163555"
}
},
"customer": {
"data": {
"type": "customer",
"id": "129522"
}
},
"receivePaymentTransaction": {
"data": {
"type": "transaction",
"id": "101"
}
}
}
}
Declined Incoming Payment
DeclinedIncomingPayment is a JSON:API resource, top-level fields:
id
string
Identifier of the declined incoming payment resource.
type
string
Type of the declined incoming payment resource. The value is always
declinedIncomingPayment.attributes
JSON Object
JSON object representing the declined incoming payment resource.
relationships
JSON:API Relationships
Describes relationships between the declined incoming payment and the originating deposit account and customer.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
direction
string
The direction in which the funds flow (either
Debit or Credit).amount
integer
The amount (cents) of the payment.
type
string
Type of the payment resource.
Currently only AchPayment payment type is supported.
Relationships
customer
OptionalJSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
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:
id
string
Identifier of the ACH repayment resource.
type
string
Type of the payment resource. For ach repayment the value is
achRepayment.attributes
JSON Object
JSON object representing the repayment resource.
relationships
JSON:API Relationships
Describes relationships between the ACH repayment and the originating deposit account, credit account and org.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
updatedAt
RFC3339 Date string
The date the resource was updated.
amount
integer
The amount (cents) of the payment.
status
string
Either Pending, PendingReview, Returned, Sent or Rejected
Relationships
customer
Optional, JSON:API Relationship
The Customer the credit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
recurringRepayment
JSON:API Relationship
Only present when re repayment was created through a Recurring Repayment.
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"
}
},
"recurringRepayment": {
"data": {
"type": "recurringRepayment",
"id": "4"
}
}
}
}
}
ACH Stop Payment
achStopPayment is a JSON:API resource, top-level fields:
id
string
Identifier of the ACH stop payment resource.
type
string
Type of the ACH stop payment resource. The value is always
achStopPayment.attributes
JSON Object
JSON object representing the ACH stop payment resource.
relationships
JSON:API Relationships
Describes relationships between the ACH stop payment resource and other resources
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
updatedAt
RFC3339 Date string
The date the resource was updated.
minAmountOptional
integer
Optional. The amount (cents) above which a received ACH payments will be stopped.
originatorNameOptional
Array of strings
Optional. Array of originator names to look on a payment to stop.
direction
string
Debit only.expiration
RFC3339 Date string
Expiration date fo the stop payment
isMultiUse
Boolean
description
String
disableReasonOptional
string
Optional. One of
Expired, Requested or PaymentStoppedRelationships
account
JSON:API Relationship
The Deposit Account receiving the check payment and will be debited for it.
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example achStopPayment resource:
{
"type": "achStopPayment",
"id": "13235",
"attributes": {
"createdAt": "2023-02-05T18:32:34.682Z",
"updatedAt": "2023-02-05",
"minAmount": 21000,
"direction": "Debit",
"isMultiUse": true,
"expiration": "2025-02-05T18:32:34.682Z",
"status": "Active",
"description": "Test",
"tags": {
"test": "test"
}
},
"relationships": {
"account": {
"data": {
"type": "account",
"id": "123456"
}
},
"customer": {
"data": {
"type": "customer",
"id": "95032"
}
},
"customers": {
"data": [
{
"type": "customer",
"id": "95032"
}
]
}
}
}
Adjustment Transaction
AdjustmentTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
adjustmentTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
description
string
Description of the transaction.
Relationships
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"
}
}
}
}
APIToken
APIToken is a JSON:API resource, top-level fields:
id
string
Identifier of the api token resource.
type
string
Type of the api token resource. The value is always
apiToken.attributes
JSON Object
JSON object representing the api token data.
Attributes
createdAt
RFC3339 Date string
The date the API token was created.
description
string
A description of the API token.
expiration
RFC3339 Date string
Expiration date of the API token.
tokenOptional
string
Optional. The actual bearer token. Available only on API token creation response.
sourceIpOptional
string
Optional. A comma separated list of IP addresses that are allowed to use the API token.
Example APIToken resource:
{
"data": {
"id": "20",
"type": "apiToken",
"attributes": {
"createdAt": "2021-07-01T09:04:50.987Z",
"description": "Production token",
"expiration": "2022-07-01T13:47:17.000Z",
"token": "v2.public.eyJyb2xlIjoib3JnI..."
}
}
}
ApplicationDocument
ApplicationDocument is a JSON:API resource, top-level fields:
id
string
Identifier of the document resource.
type
string
Always
document.attributes
JSON Object
JSON object representing the document's data.
Attributes
statusRequired
string
One of
Required, ReceivedBack, ReceivedFront, Invalid, Approved or PendingReview, see Application Document Status.documentType
string
One of
IdDocument, Passport, AddressVerification, CertificateOfIncorporation, EmployerIdentificationNumberConfirmation, SocialSecurityCard, ClientRequested or SelfieVerification.description
string
The document requirements description.
name
string
Name of business or individual.
dateOfBirth
RFC3339 Date string
Date only (e.g.
"2001-08-15"). Present only for Passport and IdDocument document types.passport
string
Individual passport number. Present only for the
Passport document type.ein
string
Business EIN. Present only for the
EmployerIdentificationNumberConfirmation document type.reasonCode
string
Application Document rejection reason code. Present only when document status is
Invalid. One of PoorQuality, NameMismatch, SSNMismatch, AddressMismatch, DOBMismatch, ExpiredId, EINMismatch, StateMismatch, Other.reason
string
Application Document rejection reason. Present only when document status is
Invalid.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"
}
}
Approved Credit Application
ExistingCustomerCreditApplication is a JSON:API resource, top-level fields:
id
string
Identifier of the application resource.
type
string
Type of the credit application resource. For existingCustomerCreditApplication the value is always
existingCustomerCreditApplication.attributes
JSON Object
JSON object representing the credit application data.
relationships
JSON:API Relationships
Describes relationships between the credit application resource and other resources.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
status
string
The status of the credit application. will be always
Approved.aggregatorAccessTokensOptional
Array of string
Optional. Array of aggregator access tokens which are Plaid (or other account linking platform) integration tokens. See Plaid processor token
annualIncomeOptional
Integer (Cents)
Optional. The annual income of the applicant.
yearsInBusinessOptional
Integer
Optional. Number of years the business has been in operation.
additionalUnderwritingDataOptional
json
Optional. Object containing key-value pairs of underwriting data per credit policy.
Relationships
lendingProgram
JSON:API Relationship
The LendingProgram to which this credit application is related to.
Example approvedCreditApplication resource:
{
"data": {
"type": "existingCustomerCreditApplication",
"id": "12",
"attributes": {
"createdAt": "2024-02-18T12:33:32.158Z",
"status": "Approved",
"aggregatorAccessTokens": [],
"annualIncome": 1,
"numberOfEmployees": "One",
"yearsInBusiness": 4,
"additionalUnderwritingData": {
"dad": "dada"
}
},
"relationships": {
"customer": {
"data": {
"type": "customer",
"id": "10002"
}
},
"lendingProgram": {
"data": {
"type": "lendingProgram",
"id": "1"
}
}
}
}
}
ATM Authorization Request
AtmAuthorizationRequest is a JSON:API resource, top-level fields:
id
string
Identifier of the authorization request resource.
type
string
Type of the authorization request resource. The value is always
atmAuthorizationRequest.attributes
JSON Object
JSON object representing the authorization request data.
relationships
JSON:API Relationships
Describes relationships between the authorization request resource and other resources (account, customer and card).
Attributes
createdAt
RFC3339 Date string
The date the authorization request was created.
amount
integer
The amount (cents) of the authorization request.
status
string
The status of the authorization request. Either
Pending, Approved or Declined.partialApprovalAllowed
boolean
Indicates whether the authorization request supports partial amount approval.
approvedAmountOptional
integer
Optional. The amount (cents) that was approved. Available only when status is
Approved.declineReasonOptional
string
Optional. The reason the authorization request was declined. One of
AccountClosed, CardExceedsAmountLimit, DoNotHonor, InsufficientFunds, InvalidMerchant, ReferToCardIssuer, RestrictedCard, Timeout, TransactionNotPermittedToCardholder. Available only when status is Declineddirection
string
The direction in which the funds flow (either
Debit or Credit).atmName
string
The name of the ATM.
atmLocationOptional
string
Optional. The location (city, state, etc.) of the ATM.
surcharge
number
The surcharge fee (cents) for the transaction.
internationalServiceFeeOptional
number
Optional. The fee (cents) for international transactions.
cardNetworkOptional
string
Optional. The card network used, one of:
Visa, Interlink, Accel, Allpoint, Other.currencyConversionOptional
Optional. When original currency for transaction is not USD.
isInternationalOptional
boolean
Optional. Indicates whether the transaction is international.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example 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",
"currencyConversion": {
"originalCurrency": "EUR",
"amountInOriginalCurrency": 1000,
"fxRate": "1.164"
},
"isInternational": true
},
"relationships": {
"customer": {
"data": {
"type": "customer",
"id": "10000"
}
},
"account": {
"data": {
"type": "account",
"id": "10001"
}
},
"card": {
"data": {
"type": "card",
"id": "7"
}
}
}
}
ATM Authorization Request V2
ATM Authorization Request V2 is a JSON:API resource, top-level fields:
type
string
Type of the authorization request resource. The value is always
pendingAuthorizationRequest.id
string
The authorization request id
attributes
JSON Object
JSON object representing the authorization request data.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
available
integer
The available balance for spending (in cents).
status
string
The status of the request. will be always "Pending"
partialApprovalAllowed
boolean
Indicates whether the authorization request supports partial amount approval.
direction
string
The direction in which the funds flow (either
Debit or Credit).atmName
string
The name of the ATM.
atmLocationOptional
string
Optional. The location (city, state, etc.) of the ATM.
surcharge
number
The surcharge fee (cents) for the transaction.
internationalServiceFeeOptional
number
Optional. The fee (cents) for international transactions.
mustBeApproved
boolean
Indicates whether the authorization request must be approved.
currencyConversionOptional
Optional. When original currency for transaction is not USD.
isInternationalOptional
boolean
Optional. Indicates whether the transaction is international.
cardNetworkOptional
string
Optional. The network that this card is a part of, e.g. Visa, Interlink, etc.
Example ATM Authorization Request V2 resource:
{
"data": [
{
"type": "pendingAuthorizationRequest",
"id": "125",
"attributes": {
"createdAt": "2023-07-20T09:27:49.702Z",
"amount": 2500,
"available": 336350,
"status": "Pending",
"partialApprovalAllowed": false,
"direction": "Debit",
"atmName": "HOME FED SAV BK",
"surcharge": 0,
"mustBeApproved": false,
"idempotencyKey": "9345cd5e-3110-48bb-8b8c-09b3b714164e",
"currencyConversion": {
"originalCurrency": "EUR",
"amountInOriginalCurrency": 1000,
"fxRate": "1.164"
},
"isInternational": true,
"cardNetwork": "Visa"
},
"relationships": {
"account": {
"data": {
"id": "10005",
"type": "account"
}
},
"customer": {
"data": {
"id": "10001",
"type": "customer"
}
},
"card": {
"data": {
"id": "28",
"type": "card"
}
},
"authorizationRequest": {
"data": {
"id": "125",
"type": "atmAuthorizationRequest"
}
}
}
}
]
}
ATM Location
ATM Location is a JSON:API resource, top-level fields:
type
string
Type of the ATM location resource. The value is always
atmLocation.attributes
JSON Object
JSON object representing the ATM location data.
Attributes
network
string
Name of the ATM network.
locationName
string
Name of the ATM's location.
distance
number
Distance to the ATM (in miles).
surchargeFree
boolean
Indicates if the ATM is surcharge free.
acceptDeposits
boolean
Indicates if the ATM accepts deposits.
Example ATM Location resource:
{
"type": "atmLocation",
"attributes": {
"network": "Allpoint",
"locationName": "SPEEDWAY",
"coordinates": {
"longitude": -73.93041,
"latitude": 42.79894
},
"address": {
"street": "229 S BRANDYWINE AVE",
"city": "SCHENECTADY",
"state": "NY",
"postalCode": "12307",
"country": "US"
},
"distance": 1.07,
"surchargeFree": true,
"acceptDeposits": false
}
}
ATM Transaction
AtmTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
atmTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account and customer).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction, including the surcharge fee. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
cardLast4Digits
string
The last 4 digits of the debit card involved in the transaction.
atmName
string
The name of the ATM.
atmLocationOptional
string
Optional. The location (city, state, etc.) of the ATM.
surcharge
number
The surcharge fee (cents) for the transaction.
interchangeOptional
string
Optional. The interchange share for this transaction. Calculated at the end of each day, see the transaction.updated event.
grossInterchangeOptional
string
Optional. The gross interchange share for this transaction.
cardNetworkOptional
string
Optional. The card network used, one of:
Visa, Interlink, Accel, Allpoint, Other.currencyConversionOptional
Optional. When original currency for transaction is not USD.
### Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example 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",
"grossInterchange": "200.00"
},
"relationships": {
"account": {
"data": {
"type": "depositAccount",
"id": "1000"
}
},
"customer": {
"data": {
"type": "customer",
"id": "3"
}
},
"card": {
"data": {
"type": "card",
"id": "11"
}
}
}
}
Authorization
Authorization is a JSON:API resource, top-level fields:
id
string
Identifier of the authorization resource.
type
string
Type of the authorization resource. The value is always
authorization.attributes
JSON Object
JSON object representing the authorization data.
relationships
JSON:API Relationships
Describes relationships between the authorization resource and other resources (account and customer).
Attributes
createdAt
RFC3339 Date string
The date the authorization was created.
amount
integer
The amount (cents) of the authorization.
cardLast4Digits
string
The last 4 digits of the debit card involved in the authorization.
declineReasonOptional
string
Optional. The reason the authorization was declined. Available only when status is
DeclineddeclinedByOptional
string
Optional. The entity that declined the authorization. One of
Visa, Org, or Unit. Available only when status is Declined.merchant.name
string
The name of the merchant.
merchant.type
integer
The 4-digit ISO 18245 merchant category code (MCC).
merchant.category
string
The merchant category, described by the MCC code (see this reference for the list of category descriptions).
merchant.locationOptional
string
Optional. The location (city, state, etc.) of the merchant.
merchant.idOptional
string
Optional. The unique network merchant identifier.
recurring
boolean
Indicates whether the authorization is recurring
paymentMethodOptional
string
Optional. The payment method used, one of:
Manual, Swipe, Contactless, ChipAndPin, Stored, Other.digitalWalletOptional
string
Optional. The type of digital wallet used, one of:
Google, Apple, Other.cardVerificationData.verificationMethodOptional
string
Optional. The verification method used, one of:
Address, CVV2, AddressAndCVV2.cardNetworkOptional
string
Optional. The card network used, one of:
Visa, Interlink, Accel, Allpoint, Other.cashWithdrawalAmountOptional
integer
Optional. Cash withdrawal amount
summaryOptional
string
Optional. Summary of the authorization.
currencyConversionOptional
Optional. When original currency for transaction is not USD
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
authorizationRequest
Optional, JSON:API Relationship
The preceding authorization request, if present (see Authorization Requests).
Example Authorization (Approved):
{
"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",
"summary": "Europcar Mobility Group |**0019 "
},
"relationships": {
"customer": {
"data": {
"type": "customer",
"id": "10000"
}
},
"account": {
"data": {
"type": "account",
"id": "10001"
}
},
"card": {
"data": {
"type": "card",
"id": "10501"
}
}
}
}
Example Authorization (Declined):
{
"type": "authorization",
"id": "176",
"attributes": {
"createdAt": "2021-02-21T07:29:42.447Z",
"amount": 2000,
"cardLast4Digits": "0019",
"status": "Declined",
"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",
"summary": "Europcar Mobility Group |**0019 ",
"declinedReason": "InsufficientFunds",
"declinedBy": "Visa"
},
"relationships": {
"customer": {
"data": {
"type": "customer",
"id": "10000"
}
},
"account": {
"data": {
"type": "account",
"id": "10001"
}
},
"card": {
"data": {
"type": "card",
"id": "10501"
}
}
}
}
Authorization Card Fraud Case
AuthorizationCardFraudCase is a JSON:API resource, top-level fields:
id
string
Identifier of the authorization card fraud case resource.
type
string
Type of the authorization card fraud case resource. The value is always
authorizationCardFraudCaseattributes
JSON Object
JSON object representing the authorization card fraud case data.
relationships
JSON:API Relationships
Describes relationships between the authorization card fraud case resource and other resources.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
status
string
The status of the card fraud case. Can be one of
Created, Active, Closed, Expired.decision
string
The decision made for the card fraud case. Can be one of
Pending, Fraud, NoFraud.expiresAt
RFC3339 Date string
The date the card fraud case expires.
cardActivities
Array of Fraud Case Card Activity
The card activities associated with the card fraud case.
updatedAtOptional
RFC3339 Date string
Optional. The date the resource was last updated.
Relationships
Example authorizationCardFraudCase resource:
{
"data": {
"type": "authorizationCardFraudCase",
"id": "9",
"attributes": {
"createdAt": "2024-07-31T11:02:27.355Z",
"status": "Closed",
"decision": "Fraud",
"expiresAt": "2024-08-03T11:02:27.355Z",
"cardActivities": [
{
"id": "15",
"createdAt": "2024-07-31T11:02:27.355Z",
"activityType": "Authorization",
"cardActivityCreatedAt": "2024-07-31T11:02:27.270Z",
"cardActivity": "8082294",
"location": "Cupertino, CA, US",
"merchant": "Apple Inc.",
"amount": 2500,
"decision": "Fraud",
"updatedAt": "2024-07-31T11:04:43.696Z"
},
{
"id": "16",
"createdAt": "2024-07-31T11:02:27.355Z",
"activityType": "Authorization",
"cardActivityCreatedAt": "2024-07-30T14:40:13.147Z",
"cardActivity": "8069211",
"location": "Cupertino, CA, US",
"merchant": "Apple Inc.",
"amount": 100,
"decision": "NoFraud",
"updatedAt": "2024-07-31T11:04:43.696Z"
},
{
"id": "17",
"createdAt": "2024-07-31T11:02:27.355Z",
"activityType": "Transaction",
"cardActivityCreatedAt": "2024-07-30T14:40:07.534Z",
"cardActivity": "8069210",
"location": "Cupertino, CA, US",
"merchant": "Apple Inc.",
"amount": 100,
"decision": "NoFraud",
"updatedAt": "2024-07-31T11:04:43.696Z"
}
],
"updatedAt": "2024-07-31T11:04:43.696Z"
},
"relationships": {
"card": {
"data": {
"type": "card",
"id": "2200412"
}
},
"account": {
"data": {
"type": "account",
"id": "49230"
}
},
"customer": {
"data": {
"type": "customer",
"id": "49430"
}
},
"authorization": {
"data": {
"type": "authorization",
"id": "8082294"
}
}
}
}
}
BatchRelease
BatchRelease is a JSON:API resource, top-level fields:
id
string
Identifier of the batch-release resource.
type
string
Type of the batch-release resource. The value is always
batchRelease.attributes
JSON Object
JSON object representing the batch-release data.
relationships
JSON:API Relationships
Describes relationships between the batch-release resource and other resources (accounts).
Attributes
amount
integer
The amount (in cents) to move from the batch account to the receiver account.
description
string
Description of the payment.
senderName
string
Name of the sender, before combining the payments.
senderAccountNumber
string
Unique identifier to monitor for similar sending accounts, could be the BIN + last four digits of the card number OR a unique identifier generated by you for the sender.
Relationships
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"
}
}
}
}
BeneficialOwner
BeneficialOwner is a JSON:API resource, top-level fields:
id
string
Identifier of the beneficial owner resource.
type
string
Always
beneficialOwner.attributes
JSON Object
JSON object representing the beneficial owner's data.
Attributes
status
string
One of
Approved, Denied or PendingReview.ssnRequired
string
SSN of the beneficial owner (numbers only). One of
ssn or passport is required.passportRequired
string
Passport of the beneficial owner. One of
ssn or passport is required.nationalityOptional
ISO31661-Alpha2 string
Always when Passport is populated and optional when SSN is populated. Two letters representing the beneficial owner's nationality.
dateOfBirth
RFC3339 Date string
Date only (e.g.
"2001-08-15").email
string
The 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",
"occupation": "ArchitectOrEngineer",
"annualIncome": "Between50kAnd100k",
"sourceOfIncome": "EmploymentOrPayrollIncome"
}
}
Book Payment
BookPayment is a JSON:API resource, top-level fields:
id
string
Identifier of the book payment resource.
type
string
Type of the payment resource. The value is always
bookPayment.attributes
JSON Object
JSON object representing the payment resource.
relationships
JSON:API Relationships
Describes relationships between the Book payment and the originating deposit account and customer.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
status
string
Either
Sent or Rejected (see reason for details).reasonOptional
string
Optional. More information about the status.
direction
string
The direction in which the funds flow (either
Debit or Credit).description
string
Payment description (maximum of 80 characters), this will show up on statement of the counterparty.
transactionSummaryOverride
string
If this field is populated, its contents will be returned as the bookTransaction's summary field (maximum of 100 characters).
amount
string
The amount (cents) of the payment.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to a multiple individual customers.
counterpartyCustomer
JSON:API Relationship
The Customer the counterparty account belongs to. The customer is either a business or an individual, might be empty if there is more than one associated customer.
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"
}
}
}
}
}
Book Repayment
BookRepayment is a JSON:API resource, top-level fields:
id
string
Identifier of the Book repayment resource.
type
string
Type of the payment resource. For book repayment the value is
bookRepayment.attributes
JSON Object
JSON object representing book repayment resource.
relationships
JSON:API Relationships
Describes relationships between the book repayment and the originating deposit account, credit account and org.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
updatedAt
RFC3339 Date string
The date the resource was updated.
amount
integer
The amount (cents) of the payment.
status
string
Either Sent or Rejected
Relationships
customer
Optional, JSON:API Relationship
The Customer the credit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
recurringRepayment
JSON:API Relationship
Only present when re repayment was created through a Recurring Repayment.
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"
}
}
}
}
}
Book Transaction
BookTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
bookTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account and customer).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example 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"
}
}
}
}
BusinessApplication
BusinessApplication is a JSON:API resource, top-level fields:
id
string
Identifier of the application resource.
type
string
Type of the application resource, for business application the value is always
businessApplication.attributes
JSON Object
JSON object representing the application data.
relationships
JSON:API Relationships
Describes relationships between the application resource and other resources (documents).
Attributes
status
string
message
string
A message describing the
BusinessApplication status.createdAt
RFC3339 Date string
The date the resource was created.
updatedAtOptional
RFC3339 Date string
Optional. The date the resource was updated.
name
string
Name of the business.
dbaOptional
string
Optional. "Doing business as".
operatingAddressOptional
Optional. The operating address of the business. Required when the
address is of a registered agent or if any beneficial owner or officer is non-US.stateOfIncorporation
string
Two letters representing a US state.
ein
string
Business EIN (numbers only).
entityType
string
One of
LLC, Partnership, PubliclyTradedCorporation, PrivatelyHeldCorporation or NotForProfitOrganization.websiteOptional
string
Optional. Business's website.
officer
Officer representing the business, must be the
CEO, COO, CFO, President, BenefitsAdministrationOfficer, CIO, VP, AVP, Treasurer, Secretary, Controller, Manager, Partner or Member. The officer would need to go over KYC process and provide documents.beneficialOwners
Array of BeneficialOwner
Array of beneficial owners of the business. Beneficial Owner is anyone with more than 25% ownership. Beneficial Owners would need to go over KYC process and provide documents.
yearOfIncorporation
Year string
Year of incorporation of the business.
countriesOfOperationOptional
Array of ISO31661-Alpha2 strings
Optional. An array of two letter codes representing the countries of operation of the business.
stockSymbolOptional
string
Optional. The stock symbol (ticker) of the business.
ipOptional
string
Optional. IP address of the end-customer creating the application. Both IPv4 and IPv6 formats are supported. Highly recommended as a fraud prevention measure, if the information is available when submitting the application.
archived
boolean
Indicates whether the application has been archived. Archived applications are read-only and no changes can be made to them. An application becomes archived once the corresponding customer is archived.
Relationships
customerOptional
JSON:API Relationship
Optional. The created
Customer in case of approved application.applicationFormOptional
JSON:API Relationship
Optional. 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"
},
"occupation": "ArchitectOrEngineer",
"annualIncome": "Between10kAnd25k",
"sourceOfIncome": "EmploymentOrPayrollIncome",
"status": "Approved"
},
"beneficialOwners": [
{
"fullName": {
"first": "Richard",
"last": "Hendricks"
},
"ssn": "123456789",
"address": {
"street": "5230 Newell Rd",
"street2": null,
"city": "Palo Alto",
"state": "CA",
"postalCode": "94303",
"country": "US"
},
"dateOfBirth": "2001-08-10",
"phone": {
"countryCode": "1",
"number": "1555555589"
},
"email": "richard@piedpiper.com",
"occupation": "ArchitectOrEngineer",
"annualIncome": "Between10kAnd25k",
"sourceOfIncome": "EmploymentOrPayrollIncome",
"status": "Approved"
}
],
"tags": {
"userId": "106a75e9-de77-4e25-9561-faffe59d7814"
},
"archived": false,
"status": "AwaitingDocuments",
"message": "Waiting for you to upload the required documents."
},
"relationships": {
"org": {
"data": {
"type": "org",
"id": "1"
}
},
"documents": {
"data": [
{
"type": "document",
"id": "1"
},
{
"type": "document",
"id": "2"
},
{
"type": "document",
"id": "3"
}
]
},
"applicationForm": {
"data": {
"type": "applicationForm",
"id": "3"
}
}
}
}
BusinessCustomer
BusinessCustomer is a JSON:API resource, describing the business customer. Top-level fields:
id
string
Identifier of the business resource.
type
string
Type of the resource, the value is always
businessCustomer.attributes
JSON Object
JSON object representing the business data.
relationships
JSON:API Relationships
Describes relationships between the customer resource, the
Org it belongs to, and the Application it was created by.Attributes
createdAt
RFC3339 Date string
The date the resource was created.
name
string
Name of the business.
dbaOptional
string
Optional. "Doing business as".
stateOfIncorporation
string
Two letters representing a US state.
ein
string
Business EIN (numbers only).
entityType
string
One of
LLC, Partnership, PubliclyTradedCorporation, PrivatelyHeldCorporation or NotForProfitOrganization.authorizedUsers
Array of AuthorizedUser
Array of authorized users. An authorized user is someone who can participate in the One Time Password (OTP) authentication process.
status
string
Status of the customer, either
Active or Archived. You can't do any write operations on an Archived customer.archiveReasonOptional
string
Optional, only if the customer status is
Archived. The reason the customer was archived, can be one of ByBank, Inactive, FraudACHActivity, FraudCardActivity, FraudCheckActivity, FraudApplicationHistory, FraudAccountActivity, FraudClientIdentified, FraudLinkedToFraudulentCustomer.Relationships
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"
},
"canConnectWithAuthVendor": true
},
{
"fullName": {
"first": "Nelson",
"last": "Bighetti"
},
"email": "nelson-bighetti@piedpiper.com",
"phone": {
"countryCode": "1",
"number": "1234567891"
},
"canConnectWithAuthVendor": true
}
],
"status": "Active",
"eligibleProducts": [
"Banking",
"BillPay"
],
"tags": {
"userId": "106a75e9-de77-4e25-9561-faffe59d7814"
}
},
"relationships": {
"org": {
"data": {
"type": "org",
"id": "1"
}
},
"application": {
"data": {
"type": "businessApplication",
"id": "1"
}
},
"authorizedUserResources": {
"data": [
{
"type": "authorizedUserResource",
"id": "1"
},
{
"type": "authorizedUserResource",
"id": "2"
}
]
}
}
}
BusinessDebitCard
BusinessDebitCard is a JSON:API resource, top-level fields:
id
string
Identifier of the card resource.
type
string
Type of the card resource. For business debit card the value is always
BusinessDebitCard.attributes
JSON Object
JSON object representing the card data.
relationships
JSON:API Relationships
Describes relationships between the card resource and other resources (account and customer).
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
updatedAtOptional
RFC3339 Date string
Optional. The date the resource was updated.
last4Digits
string
Last 4 digits of the debit card.
expirationDate
string
Card expiration date, formatted
YYYY-MM, e.g "2020-05".ssnOptional
string
Optional. SSN of the card holder (numbers only), if specified during card creation.
passportOptional
string
Optional. Passport number of the card holder, if specified during card creation.
nationalityOptional
ISO31661-Alpha2 string
Always when Passport is populated and optional when SSN is populated. Two letters representing the card holder nationality. (e.g. "US").
dateOfBirth
RFC3339 Date string
Date of birth of the card holder (e.g.
"2001-08-15").bin
string
9-digit Bank Identification Number (BIN).
email
string
Email address of the card holder.
status
string
Status of the card, one of:
Active, Inactive, Stolen, Lost, Frozen, ClosedByCustomer, SuspectedFraud.designOptional
string
Optional. Card design, if specified.
Relationships
Example BusinessDebitCard resource:
{
"type": "businessDebitCard",
"id": "9",
"attributes": {
"createdAt": "2020-05-13T09:42:21.857Z",
"last4Digits": "2074",
"expirationDate": "2022-05",
"bin": "123456789",
"shippingAddress": {
"street": "5230 Newell Rd",
"street2": null,
"city": "Palo Alto",
"state": "CA",
"postalCode": "94303",
"country": "US"
},
"address": {
"street": "5230 Newell Rd",
"street2": null,
"city": "Palo Alto",
"state": "CA",
"postalCode": "94303",
"country": "US"
},
"fullName": {
"first": "Richard",
"last": "Hendricks"
},
"phone": {
"countryCode": "1",
"number": "1555555578"
},
"email": "richard@piedpiper.com",
"dateOfBirth": "2001-08-10",
"ssn": "123456789",
"status": "Active"
},
"relationships": {
"account": {
"data": {
"type": "depositAccount",
"id": "1"
}
},
"customer": {
"data": {
"type": "businessCustomer",
"id": "1"
}
}
}
}
BusinessFBOCustomer
BusinessFBOCustomer is a JSON:API resource, describing the business fbo customer. Top-level fields:
id
string
Identifier of the business resource.
type
string
Type of the resource, the value is always
businessFBOCustomer.attributes
JSON Object
JSON object representing the business data.
relationships
JSON:API Relationships
Describes relationships between the customer resource, the
Org it belongs to, and the Application it was created by.Attributes
createdAt
RFC3339 Date string
The date the resource was created.
businessName
string
Name of the business.
name
string
The offical name
bankName
string
the name of the bank.
authorizedUsers
Array of AuthorizedUser
Array of authorized users. An authorized user is someone who can participate in the One Time Password (OTP) authentication process.
Relationships
Example BusinessFBOCustomer resource:
{
"type": "businessFBOCustomer",
"id": "1",
"attributes": {
"createdAt": "2023-07-23T09:13:18.926Z",
"businessName": "Pied Piper",
"name": "Piermont for the benefit of Pied Piper",
"businessVertical": "RepairAndMaintenance",
"bankName": "Piermont",
"numberOfEmployees": "Between10And50",
"address": {
"street": "1463 41st Avenue",
"city": "San Francisco",
"state": "CA",
"postalCode": "94122",
"country": "US"
},
"tags": {},
"authorizedUsers": [
{
"fullName": {
"first": "Erlich",
"last": "Backman"
},
"email": "erlich-backman@piedpiper.com",
"phone": {
"countryCode": "1",
"number": "1234567890"
},
"canConnectWithAuthVendor": true
},
{
"fullName": {
"first": "Nelson",
"last": "Bighetti"
},
"email": "nelson-bighetti@piedpiper.com",
"phone": {
"countryCode": "1",
"number": "1234567891"
},
"canConnectWithAuthVendor": true
}
]
},
"relationships": {
"org": {
"data": {
"type": "org",
"id": "1"
}
},
"authorizedUserResources": {
"data": [
{
"type": "authorizedUserResource",
"id": "1"
},
{
"type": "authorizedUserResource",
"id": "2"
}
]
}
}
}
BusinessVirtualDebitCard
BusinessVirtualDebitCard is a JSON:API resource, top-level fields:
id
string
Identifier of the card resource.
type
string
Type of the card resource. For business virtual debit card the value is always
businessVirtualDebitCard.attributes
JSON Object
JSON object representing the card data.
relationships
JSON:API Relationships
Describes relationships between the card resource and other resources (account and customer).
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
updatedAtOptional
RFC3339 Date string
Optional. The date the resource was updated.
last4Digits
string
Last 4 digits of the debit card.
expirationDate
string
Card expiration date, formatted
YYYY-MM, e.g "2020-05".ssnOptional
string
Optional. SSN of the card holder (numbers only), if specified during card creation.
passportOptional
string
Optional. Passport number of the card holder, if specified during card creation.
nationalityOptional
ISO31661-Alpha2 string
Always when Passport is populated and optional when SSN is populated. Two letters representing the card holder nationality. (e.g. "US").
dateOfBirth
RFC3339 Date string
Date of birth of the card holder (e.g.
"2001-08-15").bin
string
9-digit Bank Identification Number (BIN).
email
string
Email address of the card holder.
status
string
Status of the card, one of:
Active, Inactive, Stolen, Lost, Frozen, ClosedByCustomer, SuspectedFraud.Relationships
Example BusinessVirtualDebitCard resource:
{
"type": "businessVirtualDebitCard",
"id": "9",
"attributes": {
"createdAt": "2020-05-13T09:42:21.857Z",
"last4Digits": "2074",
"expirationDate": "2022-05",
"bin": "123456789",
"address": {
"street": "5230 Newell Rd",
"street2": null,
"city": "Palo Alto",
"state": "CA",
"postalCode": "94303",
"country": "US"
},
"fullName": {
"first": "Richard",
"last": "Hendricks"
},
"phone": {
"countryCode": "1",
"number": "1555555578"
},
"email": "richard@piedpiper.com",
"dateOfBirth": "2001-08-10",
"ssn": "123456789",
"status": "Active"
},
"relationships": {
"account": {
"data": {
"type": "depositAccount",
"id": "1"
}
},
"customer": {
"data": {
"type": "businessCustomer",
"id": "1"
}
}
}
}
BusinessWalletCustomer
BusinessWalletCustomer is a JSON:API resource, describing the business wallet customer. Top-level fields:
id
string
Identifier of the business wallet customer resource.
type
string
Type of the resource, the value is always
businessWalletCustomer.attributes
JSON Object
JSON object representing the business data.
relationships
JSON:API Relationships
Describes relationships between the customer resource and the
Org it belongs to.Attributes
createdAt
RFC3339 Date string
The date the resource was created.
bankName
string
The name of the bank partner this customer is about to create a wallet under.
businessName
string
The name of the business this customer represents.
name
string
The offical name.
ein
string
Business EIN (numbers only).
Relationships
Example BusinessWalletCustomer resource:
{
"type": "businessWalletCustomer",
"id": "42",
"attributes": {
"createdAt": "2023-07-23T09:13:18.926Z",
"bankName": "myBankName",
"businessName": "Sirius & Snape Inc.",
"name": "Sirius & Snape Inc.",
"address": {
"street": "5230 Newell Rd",
"city": "Palo Alto",
"state": "CA",
"postalCode": "94303",
"country": "US"
},
"ein": "123456789",
"businessVertical": "TechnologyMediaOrTelecom",
"numberOfEmployees": "Between10And50",
"tags": {
"purpose": "Sirius & Snape Inc."
}
},
"relationships": {
"org": {
"data": {
"type": "org",
"id": "1"
}
}
}
}
Capital Partner ACH Repayment
capitalPartnerAchRepayment is a JSON:API resource, top-level fields:
id
string
Identifier of the Capital Partner repayment resource.
type
string
Type of the payment resource. For capital partner ACH repayment the value is
capitalPartnerAchRepayment.attributes
JSON Object
JSON object representing the repayment resource.
relationships
JSON:API Relationships
Describes relationships between the capital partner ACH repayment and the credit account.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
updatedAt
RFC3339 Date string
The date the resource was updated.
amount
integer
The amount (cents) of the payment.
status
string
Either Pending, PendingReview, Returned, Sent or Rejected
Relationships
customer
Optional, JSON:API Relationship
The Customer the credit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
payment
JSON:API Relationship
The payment created between the capital partner's account and the counterparty
recurringRepayment
JSON:API Relationship
Only present when re repayment was created through a Recurring Repayment.
Example capitalPartnerAchRepayment resource:
{
"type": "capitalPartnerAchRepayment",
"id": "1",
"attributes": {
"createdAt": "2022-09-19T09:02:13.343Z",
"updatedAt": "2022-09-19T09:02:13.343Z",
"amount": 200,
"status": "Pending"
},
"relationships": {
"counterparty": {
"data": {
"type": "counterparty",
"id": "1"
}
},
"creditAccount": {
"data": {
"type": "creditAccount",
"id": "10007"
}
},
"org": {
"data": {
"type": "org",
"id": "1"
}
},
"payment": {
"data": {
"type": "payment",
"id": "1"
}
}
}
}
Capital Partner Book Repayment
capitalPartnerBookRepayment is a JSON:API resource, top-level fields:
id
string
Identifier of the Capital Partner repayment resource.
type
string
Type of the payment resource. For capital partner book repayment the value is
capitalPartnerBookRepayment.attributes
JSON Object
JSON object representing the repayment resource.
relationships
JSON:API Relationships
Describes relationships between the capital partner book repayment and the credit account.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
updatedAt
RFC3339 Date string
The date the resource was updated.
amount
integer
The amount (cents) of the payment.
status
string
Either Pending, PendingReview, Returned, Sent or Rejected
Relationships
customer
Optional, JSON:API Relationship
The Customer the credit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
payment
JSON:API Relationship
The payment created between the capital partner's account and the counterparty
recurringRepayment
JSON:API Relationship
Only present when re repayment was created through a Recurring Repayment.
Example capitalPartnerBookRepayment resource:
{
"type": "capitalPartnerBookRepayment",
"id": "4",
"attributes": {
"createdAt": "2022-09-19T09:10:09.206Z",
"updatedAt": "2022-09-19T09:10:09.206Z",
"amount": 20,
"status": "Sent"
},
"relationships": {
"counterparty": {
"data": {
"type": "account",
"id": "10008"
}
},
"creditAccount": {
"data": {
"type": "creditAccount",
"id": "10007"
}
},
"customer": {
"data": {
"type": "customer",
"id": "10002"
}
},
"org": {
"data": {
"type": "org",
"id": "1"
}
},
"payment": {
"data": {
"type": "payment",
"id": "5"
}
},
"recurringRepayment": {
"data": {
"type": "recurringRepayment",
"id": "4"
}
}
}
}
Card Fraud Outreach Policy
CardFraudOutreachPolicy is a JSON:API resource, top-level fields:
id
string
Identifier of the card fraud outreach policy resource.
type
string
Type of the card fraud outreach policy resource. The value is always
cardFraudOutreachPolicyattributes
JSON Object
JSON object representing the card fraud outreach policy data.
relationships
JSON:API Relationships
Describes relationships between the card fraud outreach policy resource and other resources.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
activitiesLookBackPeriodHours
integer
The period in hours before the card fraud case was created, for which the card fraud case activities were included in the case. Can be one of the following periods:
12, 24, 48, 72caseExpirationPeriodHours
integer
The period in hours after the card fraud case was created, after which the card fraud case expires. Can be one of the following periods:
12, 24, 48, 72.numberOfActivities
integer
The number of card activities that are included in the card fraud case. Up to
5 activities max.contactUrl
string
The client support contact URL.
enabled
boolean
Indicates whether the policy is enabled.
Relationships
emailOutreachSettings
JSON:API Relationship
The
EmailOutreachSettings that is associated to the card fraud outreach policy, if it was set on.whiteLabelTheme
JSON:API Relationship
The
WhiteLabelTheme that is associated to the policy, if it was set on.Example cardFraudOutreachPolicy resource:
{
"data": {
"type": "cardFraudOutreachPolicy",
"id": "1",
"attributes": {
"createdAt": "2024-07-30T14:29:29.986Z",
"activitiesLookBackPeriodHours": 72,
"caseExpirationPeriodHours": 72,
"numberOfActivities": 3,
"contactPhone": {
"countryCode": "213",
"number": "5350405030"
},
"contactUrl": "https://thisIsMyDomain.unit.co",
"fraudRulesSuppressionDays": 1,
"enabled": true
},
"relationships": {
"emailOutreachSettings": {
"data": {
"type": "emailOutreachSettings",
"id": "10023"
}
},
"messageOutreachSettings": {
"data": {
"type": "messageOutreachSettings",
"id": "10022"
}
},
"whiteLabelTheme": {
"data": {
"type": "whiteLabelTheme",
"id": "54728"
}
}
}
}
}
Card Reversal Transaction
CardReversalTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
cardReversalTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account, customer and relatedTransaction).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
cardLast4Digits
string
The last 4 digits of the debit card involved in the transaction.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
relatedTransactionOptional
JSON:API Relationship
Optional. 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": {
"data": {
"type": "card",
"id": "11"
}
}
}
}
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:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
cardTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account and customer).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
cardLast4Digits
string
The last 4 digits of the debit card involved in the transaction.
merchant.nameOptional
string
Optional. The name of the merchant.
merchant.typeOptional
integer
Optional. The 4-digit ISO 18245 merchant category code (MCC).
merchant.categoryOptional
string
Optional. The merchant category, described by the MCC code (see this reference for the list of category descriptions).
merchant.locationOptional
string
Optional. The location (city, state, etc.) of the merchant.
merchant.idOptional
string
Optional. The unique network merchant identifier.
recurringOptional
boolean
Optional. Indicates whether the transaction is recurring.
interchangeOptional
string
Optional. The interchange share for this transaction. Calculated at the end of each day, see the transaction.updated event.
grossInterchangeOptional
string
Optional. The gross interchange share for this transaction.
paymentMethodOptional
string
Optional. The payment method used, one of:
Manual, Swipe, Contactless, ChipAndPin, Stored, Other.digitalWalletOptional
string
Optional. The type of digital wallet used, one of:
Google, Apple, Other.cardVerificationData.verificationMethodOptional
string
Optional. The verification method used, one of:
Address, CVV2, AddressAndCVV2.cardNetworkOptional
string
Optional. The card network used, one of:
Visa, Interlink, Accel, Allpoint, Other.currencyConversionOptional
Optional. When original currency for transaction is not USD.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
authorizationOptional
JSON:API Relationship
Optional. The Authorization request made, if present (see Authorizations).
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",
"grossInterchange": "200.00",
"paymentMethod": "Contactless",
"digitalWallet": "Apple",
"cardVerificationData": {
"verificationMethod": "CVV2"
},
"cardNetwork": "Visa"
},
"relationships": {
"account": {
"data": {
"type": "account",
"id": "10001"
}
},
"customer": {
"data": {
"type": "customer",
"id": "1001"
}
},
"card": {
"data": {
"type": "card",
"id": "11"
}
}
}
}
Card Transaction Authorization Request
CardTransactionAuthorizationRequest is a JSON:API resource, top-level fields:
id
string
Identifier of the card transaction authorization request resource.
type
string
Type of the card transaction authorization request resource. The value is always
cardTransactionAuthorizationRequest.attributes
JSON Object
JSON object representing the authorization request data.
relationships
JSON:API Relationships
Describes relationships between the authorization request resource and other resources (account, customer and card).
Attributes
createdAt
RFC3339 Date string
The date the authorization request was created.
amount
integer
The amount (cents) of the authorization request.
status
string
The status of the authorization request. Either
Pending, Approved or Declined.partialApprovalAllowed
boolean
Indicates whether the authorization request supports partial amount approval.
approvedAmountOptional
integer
Optional. The amount (cents) that was approved. Available only when status is
Approved.declineReasonOptional
string
Optional. The reason the authorization request was declined. One of
AccountClosed, CardExceedsAmountLimit, DoNotHonor, InsufficientFunds, InvalidMerchant, ReferToCardIssuer, RestrictedCard, Timeout, TransactionNotPermittedToCardholder. Available only when status is Declinedmerchant.name
string
The name of the merchant.
merchant.type
integer
The 4-digit ISO 18245 merchant category code (MCC).
merchant.category
string
The merchant category, described by the MCC code (see this reference for the list of category descriptions).
merchant.locationOptional
string
Optional. The location (city, state, etc.) of the merchant.
merchant.idOptional
string
Optional. The unique network merchant identifier.
recurring
boolean
Indicates whether the authorization is recurring
paymentMethodOptional
string
Optional. The payment method used, one of:
Manual, Swipe, Contactless, ChipAndPin, Stored, Other.digitalWalletOptional
string
Optional. The type of digital wallet used, one of:
Google, Apple, Other.cardVerificationData. verificationMethodOptional
string
Optional. The verification method used, one of:
Address, CVV2, AddressAndCVV2.cardNetworkOptional
string
Optional. The card network used, one of:
Visa, Interlink, Accel, Allpoint, Other.currencyConversionOptional
Optional. When original currency for transaction is not USD.
isInternationalOptional
boolean
Optional. Indicates whether the transaction is international.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
fundingAccount
Optional, JSON:API Relationship
An 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",
"currencyConversion": {
"originalCurrency": "EUR",
"amountInOriginalCurrency": 1000,
"fxRate": "1.164"
},
"isInternational": true
},
"relationships": {
"customer": {
"data": {
"type": "customer",
"id": "10000"
}
},
"account": {
"data": {
"type": "account",
"id": "10001"
}
},
"card": {
"data": {
"type": "card",
"id": "7"
}
}
}
}
Card Transaction Authorization Request V2
Card Transaction Authorization Request V2 is a JSON:API resource, top-level fields:
type
string
Type of the authorization request resource. The value is always
pendingAuthorizationRequest.id
string
The authorization request id
attributes
JSON Object
JSON object representing the authorization request data.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
available
integer
The available balance for spending (in cents).
status
string
The status of the request. will be always "Pending"
partialApprovalAllowed
boolean
Indicates whether the authorization request supports partial amount approval.
merchant.name
string
The name of the merchant.
merchant.type
integer
The 4-digit ISO 18245 merchant category code (MCC).
merchant.locationOptional
string
Optional. The location (city, state, etc.) of the merchant.
merchant.idOptional
string
Optional. The unique network merchant identifier.
recurring
boolean
Indicates whether the authorization is recurring
direction
string
The direction in which the funds flow (either
Debit or Credit).mustBeApproved
boolean
Indicates whether the authorization request must be approved.
paymentMethodOptional
string
Optional. The payment method used, one of:
Manual, Swipe, Contactless, ChipAndPin, Stored, Other.currencyConversionOptional
Optional. When original currency for transaction is not USD.
isInternationalOptional
boolean
Optional. Indicates whether the transaction is international.
cardNetworkOptional
string
Optional. The network that this card is a part of, e.g. Visa, Interlink, etc.
Example Card Transaction Authorization Request V2 resource:
{
"data": [
{
"id": "415",
"type": "pendingAuthorizationRequest",
"attributes": {
"createdAt": "2021-06-24T08:10:08.081Z",
"amount": 2000,
"available": 150000,
"status": "Pending",
"direction": "Debit",
"partialApprovalAllowed": false,
"merchant": {
"name": "Merchant name",
"type": "6012",
"id": "311204598883"
},
"recurring": false,
"mustBeApproved": false,
"tags": {
"tag": "value"
},
"idempotencyKey": "9345cd5e-3110-48bb-8b8c-09b3b714164e",
"currencyConversion": {
"originalCurrency": "EUR",
"amountInOriginalCurrency": 1000,
"fxRate": "1.164"
},
"isInternational": true,
"cardNetwork": "Visa"
},
"relationships": {
"authorizationRequest": {
"data": {
"id": "8",
"type": "CardTransactionAuthorizationRequest"
}
},
"account": {
"data": {
"id": "10001",
"type": "account"
}
},
"customer": {
"data": {
"id": "10000",
"type": "customer"
}
},
"card": {
"data": {
"id": "7",
"type": "card"
}
}
}
}
]
}
Cash Deposit Barcode
Cash Deposit Barcode is a JSON:API resource, top-level fields:
type
string
Type of the Cash Deposit Barcode resource. The value is always
cashDepositBarcode.attributes
JSON Object
JSON object representing the Cash Deposit Barcode data.
Attributes
barcodeNumber
string
Unique identifier of the barcode. This field will be used in Get Barcode Image by Barcode Number endpoint.
expiration
ISO 8601 Date and time string
The expiration date and time of the barcode
storeId
string
Identifier of the retail store that supports Cash Deposits. This field is obtained from the obtained from either List by coordinates or List by post code endpoints.
retailerName
string
Name of the retailer store that supports Cash Deposits.
Relationships
Example Cash Deposit Barcode resource:
{
"data": {
"type": "cashDepositBarcode",
"attributes": {
"barcodeNumber": "123456789123456789000000000000",
"expiration": "2023-12-26T13:37:23.927Z",
"storeId": "2481",
"retailerName": "7-Eleven"
},
"relationships": {
"customer": {
"data": {
"type": "customer",
"id": "10001"
}
},
"account": {
"data": {
"type": "account",
"id": "10002"
}
}
}
}
}
Cash Deposit Transaction
CashDepositTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
cashDepositTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources.
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example CashDepositTransaction resource:
{
"type": "cashDepositTransaction",
"id": "1523",
"attributes": {
"createdAt": "2020-07-05T15:49:36.864Z",
"direction": "Credit",
"amount": 10000,
"balance": 12000,
"summary": "Cash deposit at Walgreens | Via card ending with 1234"
},
"relationships": {
"account": {
"data": {
"type": "depositAccount",
"id": "1000"
}
},
"customer": {
"data": {
"type": "customer",
"id": "3"
}
}
}
}
Chargeback
This resource is generated as a result of a chargeback creation request.
Chargeback is a JSON:API resource, top-level fields:
id
string
Identifier of the chargeback resource.
type
string
Type of the chargeback resource. The value is always
chargeback.attributes
JSON Object
JSON object representing the fee data.
relationships
JSON:API Relationships
Describes relationships between the chargeback resource and other resources (accounts, transaction, customer).
Attributes
createdAt
RFC3339 Date string
The date the chargeback was created.
amount
integer
The amount (in cents) of the chargeback.
description
string
Description of the chargeback.
Relationships
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": {
"data": {
"type": "customer",
"id": "10007"
}
},
"counterpartyAccount": {
"data": {
"type": "account",
"id": "10005"
}
},
"transaction": {
"data": {
"type": "transaction",
"id": "25"
}
}
}
}
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:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
chargebackTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (accounts, customer, chargeback).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types, this will be the description of the chargeback.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example 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"
}
}
}
}
Check Deposit
CheckDeposit is a JSON:API resource, top-level fields:
id
string
Identifier of the check deposit resource.
type
string
Type of the check deposit resource. The value is always
checkDeposit.attributes
JSON Object
JSON object representing the check deposit resource.
relationships
JSON:API Relationships
Describes relationships between the check deposit resource and other resources
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
status
string
One of
AwaitingImages, AwaitingFrontImage, AwaitingBackImage, Pending, PendingReview, Rejected, Clearing, Sent, Canceled, Returned.reasonOptional
string
Optional. More information about the status.
description
string
Check Deposit description (maximum of 50 characters).
amount
string
The amount (cents) of the check deposit.
checkNumberOptional
string
Optional. The serial number printed at the bottom of the check
clearingDaysOverrideOptional
integer
Optional. The amount of days it will take a check deposit to clear if a
clearingDaysOverride was provided. See Dynamic Clearing PeriodsettlementDateOptional
RFC3339 Date string
Optional, For
Pending or Clearing, shows the date on which the check will be settled.Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example CheckDeposit resource:
{
"data": {
"type": "checkDeposit",
"id": "11221",
"attributes": {
"createdAt": "2021-05-27T09:29:30.828Z",
"amount": 20000,
"description": "Check deposit",
"clearingDaysOverride": 5,
"status": "AwaitingImages"
},
"relationships": {
"account": {
"data": {
"type": "account",
"id": "10001"
}
},
"customer": {
"data": {
"type": "customer",
"id": "10000"
}
}
}
}
}
Check Deposit Transaction
CheckDepositTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
checkDepositTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account, customer, checkDeposit).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example 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"
}
}
}
}
}
Check Payment
CheckPayment is a JSON:API resource, top-level fields:
id
string
Identifier of the check payment resource.
type
string
Type of the check payment resource. The value is always
checkPayment.attributes
JSON Object
JSON object representing the check payment resource.
relationships
JSON:API Relationships
Describes relationships between the check payment resource and other resources
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
updatedAt
RFC3339 Date string
The date the resource was updated.
status
string
One of
New, Pending, PendingCancellation, Canceled,InDelivery, Delivered, ReturnedToSender, Processed, PendingReview, MarkedForReturn, Returned, Rejected.amount
integer
The amount (cents) of the check deposit.
description
string
Description of the Check Payment.
checkNumberOptional
string
Optional. The serial number printed at the bottom of the check
originated
boolean
True for checks originated through UnitonUsOptional
string
Optional.
onUsAuxiliaryOptional
string
Optional.
counterpartyRoutingNumberOptional
string
Optional. The routing number of the party that deposited the Check.
returnStatusReasonOptional
string
Optional. The reason the Check Payment have been marked for return or returned. See Check Payment return reasons.
rejectReasonOptional
string
Optional.
pendingReviewReasonsOptional
Array of strings
Optional. List of reasons as to why the Check Payment is in pending review status, more reasons may be added in the future, current possible reasons:
SoftLimit.returnCutoffTimeOptional
RFC3339 Date string
Optional. The last time when a return will be accepted using the return Check Payment endpoint.
additionalVerificationStatusOptional
string
Optional. One of 'Required', 'NotRequired' or 'Approved', when
Requires an additional verification will be required, see Approve Additional Verification.deliveryStatusOptional
string
Optional. One of
Mailed, InLocalArea, Delivered, Rerouted, ReturnedToSender. Available once check status is InDeliverytrackedAtOptional
RFC3339 Date string
Optional. The date of the last delivery status update.
postalCodeOptional
String
Optional. The location of the last delivery status update.
expirationDateOptional
String
Optional. check expiration date, formatted YYYY-MM--DD, e.g "2020-05-01".
expectedDelivery
String
check expected delivery date, formatted YYYY-MM--DD, e.g "2020-05-01".
sendAtOptional
RFC3339 Date string
Optional. The date and time in which the check is to be sent.
memoOptional
String
Optional. Text included on the memo line of the check.
Relationships
account
JSON:API Relationship
The Deposit Account receiving the check payment and will be debited for it.
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example CheckPayment resource:
{
"data": {
"type": "checkPayment",
"id": "3",
"attributes": {
"createdAt": "2023-02-21T11:31:03.704Z",
"updatedAt": "2023-02-21T11:31:03.704Z",
"amount": 10000,
"sendAt": "2023-09-10T12:50:00.704Z",
"description": "Check Payment | 0322",
"status": "Processed",
"deliveryStatus": "Delivered",
"trackedAt": "2023-02-23T11:31:03.704Z",
"postalCode": "94303",
"checkNumber": "0322",
"onUsAuxiliary": "0322",
"onUs": "864800000002/",
"counterparty": {
"name": "John Doe",
"address": {
"street": "5230 Newell Rd",
"city": "Palo Alto",
"state": "CA",
"postalCode": "94303"
}
},
"counterpartyRoutingNumber": "051402372",
"returnCutoffTime": "2023-03-23T15:50:00.000Z",
"additionalVerificationStatus": "Required"
},
"relationships": {
"account": {
"data": {
"type": "account",
"id": "75002"
}
},
"customer": {
"data": {
"type": "customer",
"id": "100425"
}
},
"customers": {
"data": [
{
"type": "customer",
"id": "10001"
}
]
},
"transaction": {
"data": {
"type": "transaction",
"id": "123423"
}
}
}
}
}
Check Payment Transaction
CheckPaymentTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
checkPaymentTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account, customer, checkPayment).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example CheckPaymentTransaction resource:
{
"type": "checkPaymentTransaction",
"id": "7",
"attributes": {
"createdAt": "2023-02-21T11:40:55.442Z",
"amount": 299991,
"direction": "Debit",
"balance": -1,
"summary": "Check Payment | 0322"
},
"relationships": {
"account": {
"data": {
"type": "account",
"id": "10002"
}
},
"customer": {
"data": {
"type": "customer",
"id": "10005"
}
},
"customers": {
"data": [
{
"type": "customer",
"id": "10005"
}
]
},
"checkPayment": {
"data": {
"type": "checkPayment",
"id": "5"
}
}
}
}
Check Stop Payment
checkStopPayment is a JSON:API resource, top-level fields:
id
string
Identifier of the check stop payment resource.
type
string
Type of the stop payment resource. The value is always
checkStopPayment.attributes
JSON Object
JSON object representing the check stop payment resource.
relationships
JSON:API Relationships
Describes relationships between the check stop payment resource and other resources
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
updatedAt
RFC3339 Date string
The date the resource was updated.
amountOptional
integer
Optional. The amount (cents) of the check payment.
status
string
The status of the stop payment, one of
Active or Disabled.checkNumber
string
The
checkNumber of the check payments that the stop payment operation will be applied to.Relationships
account
JSON:API Relationship
The Deposit Account receiving the check payment and will be debited for it.
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
stoppedPayments
Optional, Array of JSON:API Relationship
The list of CheckPayments that were stopped by this
stopPayment.Example checkStopPayment resource:
{
"type": "checkStopPayment",
"id": "13235",
"attributes": {
"createdAt": "2023-02-05T18:32:34.682Z",
"updatedAt": "2023-02-05T18:32:34.682Z",
"amount": 21323,
"status": "Active",
"tags": {
"test": "test"
},
"checkNumber": "006753"
},
"relationships": {
"account": {
"data": {
"type": "account",
"id": "123456"
}
},
"customer": {
"data": {
"type": "customer",
"id": "95032"
}
},
"customers": {
"data": [
{
"type": "customer",
"id": "95032"
}
]
}
}
}
Counterparty Balance
Counterparty is a JSON:API resource, top-level fields:
id
string
Identifier of the Counterparty.
type
string
Type of the balance. for counterparty balance the value is always counterpartyBalance.
attributes
JSON Object
JSON object representing the counterparty balance resource.
relationships
JSON:API Relationships
Describes relationships between the counterparty balance and the customer and counterparty.
Attributes
balance
number
The current balance amount (in cents) of the counterparty.
availableOptional
number
Optional. The available balance amount (in cents) of the counterparty.
Relationships
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"
}
}
}
}
}
Credit Application Decision
Manual Review Credit Application Decision
manualReviewCreditApplicationDecision is a JSON:API resource, top-level fields:
id
string
Identifier of the credit decision resource.
type
string
Type of the credit decision resource. The value is always
manualReviewCreditApplicationDecision.attributes
JSON Object
JSON object representing the credit decision data.
relationships
JSON:API Relationships
Describes relationships between the credit decision resource and other resources.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
externalApplicationId
string
Identifier for client's credit evaluation related to this decision. Max 200 char.
evaluationType
string
The type of credit decision. This is always
CreditApplication.submissionTimestamp
timestamp
Timestamp when the corresponding credit application was submitted.
decisionTimestamp
timestamp
Timestamp when the credit decision was made.
decision
string
The Decision for this credit application. This is always
ManualReview.policyException
boolean
One of
true or false.policyExceptionReason
string
Conditional if policyException is
true. Brief description of reason for policy exception. Max 200 char.additionalUnderwritingData
json
Object containing key-value pairs of underwriting data per credit policy.
Relationships
creditApplicationOptional
JSON:API Relationship
Optional. The Credit Application for which this credit decision applies to.
Example manualReviewCreditApplicationDecision resource:
{
"data": {
"type": "manualReviewCreditApplicationDecision",
"id": "1",
"attributes": {
"createdAt": "2023-07-04T15:21:11.688Z",
"externalApplicationId": "A1234",
"evaluationType": "CreditApplication",
"submissionTimestamp": "2023-09-19T09:10:09.206Z",
"decisionTimestamp": "2023-09-19T09:10:09.206Z",
"decision": "ManualReview",
"policyException": true,
"policyExceptionReason": "Executive approval",
"additionalUnderwritingData": {
"someKey1": "someValue1",
"someKey2": "someValue2",
"someKey3": "someValue3"
}
},
"relationships": {
"application": {
"data": {
"type": "application",
"id": "10005"
}
}
}
}
}
Approved Credit Application Decision
approvedCreditApplicationDecision is a JSON:API resource, top-level fields:
id
string
Identifier of the credit decision resource.
type
string
Type of the credit decision resource. The value is always
approvedCreditApplicationDecision.attributes
JSON Object
JSON object representing the credit decision data.
relationships
JSON:API Relationships
Describes relationships between the credit decision resource and other resources.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
externalApplicationId
string
Identifier for client's credit evaluation related to this decision. Max 200 char.
evaluationType
string
The type of credit decision. This is always
CreditApplication.submissionTimestamp
timestamp
Timestamp when the corresponding credit application was submitted.
decisionTimestamp
timestamp
Timestamp when the credit decision was made.
decision
string
The Decision for this credit application. This is always
Approved.policyException
boolean
One of
true or false.policyExceptionReason
string
Conditional if policyException is
true. Brief description of reason for policy exception. Max 200 char.additionalUnderwritingData
json
Object containing key-value pairs of underwriting data per credit policy.
creditLimit
Integer (Cents)
Credit limit for application as evaluated per policy.
Relationships
creditApplicationOptional
JSON:API Relationship
Optional. The Credit Application for which this credit decision applies to.
Example approvedCreditApplicationDecision resource:
{
"data": {
"type": "approvedCreditApplicationDecision",
"id": "1",
"attributes": {
"createdAt": "2023-07-04T15:21:11.688Z",
"externalApplicationId": "A1234",
"evaluationType": "CreditApplication",
"submissionTimestamp": "2023-09-19T09:10:09.206Z",
"decisionTimestamp": "2023-09-19T09:10:09.206Z",
"decision": "Approved",
"policyException": true,
"policyExceptionReason": "Executive approval",
"additionalUnderwritingData": {
"someKey1": "someValue1",
"someKey2": "someValue2",
"someKey3": "someValue3"
},
"creditLimit": 100000
},
"relationships": {
"application": {
"data": {
"type": "application",
"id": "10000"
}
}
}
}
}
Denied Application Decision
deniedCreditApplicationDecision is a JSON:API resource, top-level fields:
id
string
Identifier of the credit decision resource.
type
string
Type of the credit decision resource. The value is always
deniedCreditApplicationDecision.attributes
JSON Object
JSON object representing the credit decision data.
relationships
JSON:API Relationships
Describes relationships between the credit decision resource and other resources.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
externalApplicationId
string
Identifier for client's credit evaluation related to this decision. Max 200 char.
evaluationType
string
The type of credit decision. This is always
CreditApplication.submissionTimestamp
timestamp
Timestamp when the corresponding credit application was submitted.
decisionTimestamp
timestamp
Timestamp when the credit decision was made.
decision
string
The Decision for this credit application. This is always
Denied.policyException
boolean
One of
true or false.policyExceptionReason
string
Conditional if policyException is
true. Brief description of reason for policy exception. Max 200 char.additionalUnderwritingData
json
Object containing key-value pairs of underwriting data per credit policy.
decisionReason
string
Reason for denial per credit policy. Max 200 char.
adverseActionReasons
Array of strings
Array of strings representing Adverse action reasons (must have at least one). Max 200 char per reason.
Relationships
creditApplicationOptional
JSON:API Relationship
Optional. The Credit Application for which this credit decision applies to.
Example deniedCreditApplicationDecision resource:
{
"data": {
"type": "deniedCreditApplicationDecision",
"id": "1",
"attributes": {
"createdAt": "2023-07-04T15:21:11.688Z",
"externalApplicationId": "A1234",
"evaluationType": "CreditApplication",
"submissionTimestamp": "2023-09-19T09:10:09.206Z",
"decisionTimestamp": "2023-09-19T09:10:09.206Z",
"decision": "Denied",
"policyException": true,
"policyExceptionReason": "Executive approval",
"additionalUnderwritingData": {
"someKey1": "someValue1",
"someKey2": "someValue2",
"someKey3": "someValue3"
},
"decisionReason": "this is a decline reason",
"adverseActionReasons": [
"adverse action reason 1",
"adverse action reason 2"
]
},
"relationships": {
"application": {
"data": {
"type": "application",
"id": "10005"
}
}
}
}
}
Credit Limit Decision
Manual Review Credit Limit Decision
manualReviewCreditLimitDecision is a JSON:API resource, top-level fields:
id
string
Identifier of the credit decision resource.
type
string
Type of the credit decision resource. The value is always
manualReviewCreditLimitDecision.attributes
JSON Object
JSON object representing the credit decision data.
relationships
JSON:API Relationships
Describes relationships between the credit decision resource and other resources.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
externalApplicationId
string
Identifier for client's credit evaluation related to this decision. Max 200 char.
evaluationType
string
The type of credit decision. This is always
CreditLimit.submissionTimestamp
timestamp
Timestamp when the corresponding credit application was submitted.
decisionTimestamp
timestamp
Timestamp when the credit decision was made.
decision
string
The Decision for this credit application. This is always
ManualReview.policyException
boolean
One of
true or false.policyExceptionReason
string
Conditional if policyException is
true. Brief description of reason for policy exception. Max 200 char.additionalUnderwritingData
json
Object containing key-value pairs of underwriting data per credit policy.
Relationships
creditApplicationOptional
JSON:API Relationship
Optional. The Credit Application for which this credit decision applies to.
Example manualReviewCreditLimitDecision resource:
{
"data": {
"type": "manualReviewCreditLimitDecision",
"id": "1",
"attributes": {
"createdAt": "2023-07-04T15:21:11.688Z",
"externalApplicationId": "A1234",
"evaluationType": "CreditLimit",
"submissionTimestamp": "2023-09-19T09:10:09.206Z",
"decisionTimestamp": "2023-09-19T09:10:09.206Z",
"decision": "ManualReview",
"policyException": true,
"policyExceptionReason": "Executive approval",
"additionalUnderwritingData": {
"someKey1": "someValue1",
"someKey2": "someValue2",
"someKey3": "someValue3"
}
},
"relationships": {
"customer": {
"data": {
"type": "customer",
"id": "10000"
}
},
"account": {
"data": {
"type": "account",
"id": "10005"
}
}
}
}
}
Approved Credit Limit Decision
approvedCreditLimitDecision is a JSON:API resource, top-level fields:
id
string
Identifier of the credit decision resource.
type
string
Type of the credit decision resource. The value is always
approvedCreditLimitDecision.attributes
JSON Object
JSON object representing the credit decision data.
relationships
JSON:API Relationships
Describes relationships between the credit decision resource and other resources.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
externalApplicationId
string
Identifier for client's credit evaluation related to this decision. Max 200 char.
evaluationType
string
The type of credit decision. This is always
CreditLimit.submissionTimestamp
timestamp
Timestamp when the corresponding credit application was submitted.
decisionTimestamp
timestamp
Timestamp when the credit decision was made.
decision
string
The Decision for this credit application. This is always
Approved.policyException
boolean
One of
true or false.policyExceptionReason
string
Conditional if policyException is
true. Brief description of reason for policy exception. Max 200 char.additionalUnderwritingData
json
Object containing key-value pairs of underwriting data per credit policy.
creditLimit
Integer (Cents)
Credit limit for application as evaluated per policy.
Relationships
creditApplicationOptional
JSON:API Relationship
Optional. The Credit Application for which this credit decision applies to.
Example approvedCreditLimitDecision resource:
{
"data": {
"type": "approvedCreditLimitDecision",
"id": "1",
"attributes": {
"createdAt": "2023-07-04T15:21:11.688Z",
"externalApplicationId": "A1234",
"evaluationType": "CreditLimit",
"submissionTimestamp": "2023-09-19T09:10:09.206Z",
"decisionTimestamp": "2023-09-19T09:10:09.206Z",
"decision": "approved",
"policyException": true,
"policyExceptionReason": "Executive approval",
"additionalUnderwritingData": {
"someKey1": "someValue1",
"someKey2": "someValue2",
"someKey3": "someValue3"
},
"creditLimit": 1000000
},
"relationships": {
"customer": {
"data": {
"type": "customer",
"id": "10000"
}
},
"account": {
"data": {
"type": "account",
"id": "10005"
}
}
}
}
}
Denied Credit Limit Decision
deniedCreditLimitDecision is a JSON:API resource, top-level fields:
id
string
Identifier of the credit decision resource.
type
string
Type of the credit decision resource. The value is always
deniedCreditLimitDecision.attributes
JSON Object
JSON object representing the credit decision data.
relationships
JSON:API Relationships
Describes relationships between the credit decision resource and other resources.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
externalApplicationId
string
Identifier for client's credit evaluation related to this decision. Max 200 char.
evaluationType
string
The type of credit decision. This is always
CreditLimit.submissionTimestamp
timestamp
Timestamp when the corresponding credit application was submitted.
decisionTimestamp
timestamp
Timestamp when the credit decision was made.
decision
string
The Decision for this credit application. This is always
Denied.policyException
boolean
One of
true or false.policyExceptionReason
string
Conditional if policyException is
true. Brief description of reason for policy exception. Max 200 char.additionalUnderwritingData
json
Object containing key-value pairs of underwriting data per credit policy.
decisionReason
string
Reason for denial per credit policy. Max 200 char.
adverseActionReasons
Array of strings
Array of strings representing Adverse action reasons (must have at least one). Max 200 char per reason.
Relationships
creditApplicationOptional
JSON:API Relationship
Optional. The Credit Application for which this credit decision applies to.
Example deniedCreditLimitDecision resource:
{
"data": {
"type": "deniedCreditLimitDecision",
"id": "1",
"attributes": {
"createdAt": "2023-07-04T15:21:11.688Z",
"externalApplicationId": "A1234",
"evaluationType": "CreditLimit",
"submissionTimestamp": "2023-09-19T09:10:09.206Z",
"decisionTimestamp": "2023-09-19T09:10:09.206Z",
"decision": "Denied",
"policyException": true,
"policyExceptionReason": "Executive approval",
"additionalUnderwritingData": {
"someKey1": "someValue1",
"someKey2": "someValue2",
"someKey3": "someValue3"
},
"decisionReason": "this is a decline reason",
"adverseActionReasons": [
"adverse action reason 1",
"adverse action reason 2"
]
},
"relationships": {
"customer": {
"data": {
"type": "customer",
"id": "10000"
}
},
"account": {
"data": {
"type": "account",
"id": "10005"
}
}
}
}
}
CreditAccount
CreditAccount is a JSON:API resource, top-level fields:
id
string
Identifier of the credit account resource.
type
string
Type of the resource. Currently only
creditAccount is supported.attributes
JSON Object
JSON object representing the credit account data.
relationships
JSON:API Relationships
Describes relationships between the credit account resource and the customer.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
updatedAtOptional
RFC3339 Date string
Optional. The date the resource was updated.
name
string
Name of the account holder.
creditTerms
string
The selected credit terms.
currency
string
Currency of the account.
creditLimit
integer
The credit limit (cents).
balance
integer
The balance amount (cents). The balance represents the funds that are currently in the account (not taking into account future commitments). The balance equals the sum of settled transactions minus any repayments.
hold
integer
The hold amount (cents). The hold represents funds that are not available for spending, due to an outstanding card authorization.
available
integer
The available balance for spending (cents). Equals the credit limit, minus the balance and hold amounts.
status
string
Status of the account, either
Open, Frozen, or Closed.freezeReasonOptional
string
Optional. The reason the account was frozen, either
Fraud, ByBank, or free-text description.closeReasonOptional
string
Optional. The reason the account was closed, either
ByCustomer, Overdue or Fraud.closeReasonTextOptional
string
Optional. An expanded free-text reason for account closure.
fraudReasonOptional
string
Optional. The expanded fraud reason for closing the account when
Fraud is specified as the reason. Can be one of: (ACHActivity, CardActivity, CheckActivity, ApplicationHistory, AccountActivity, ClientIdentified, IdentityTheft, LinkedToFraudulentCustomer).Note
The currency is currently always set to USD. The balance, hold and available amounts are represented in cents.
Relationships
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"
}
}
}
}
}
Denied Credit Application
ExistingCustomerCreditApplication is a JSON:API resource, top-level fields:
id
string
Identifier of the application resource.
type
string
Type of the credit application resource. For existingCustomerCreditApplication the value is always
existingCustomerCreditApplication.attributes
JSON Object
JSON object representing the credit application data.
relationships
JSON:API Relationships
Describes relationships between the credit application resource and other resources.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
status
string
The status of the credit application. will be always
Denied.aggregatorAccessTokensOptional
Array of string
Optional. Array of aggregator access tokens which are Plaid (or other account linking platform) integration tokens. See Plaid processor token
annualIncomeOptional
Integer (Cents)
Optional. The annual income of the applicant.
yearsInBusinessOptional
Integer
Optional. Number of years the business has been in operation.
additionalUnderwritingDataOptional
json
Optional. Object containing key-value pairs of underwriting data per credit policy.
Relationships
lendingProgram
JSON:API Relationship
The LendingProgram to which this credit application is related to.
Example deniedCreditApplication resource:
{
"data": {
"type": "existingCustomerCreditApplication",
"id": "12",
"attributes": {
"createdAt": "2024-02-18T12:33:32.158Z",
"status": "Denied",
"aggregatorAccessTokens": [],
"annualIncome": 1,
"numberOfEmployees": "One",
"yearsInBusiness": 4,
"additionalUnderwritingData": {
"dad": "dada"
}
},
"relationships": {
"customer": {
"data": {
"type": "customer",
"id": "10002"
}
},
"lendingProgram": {
"data": {
"type": "lendingProgram",
"id": "1"
}
}
}
}
}
DepositAccount
DepositAccount is a JSON:API resource, top-level fields:
id
string
Identifier of the deposit account resource.
type
string
Type of the resource, the value is always
depositAccount.attributes
JSON Object
JSON object representing the deposit account data.
relationships
JSON:API Relationships
Describes relationships between the deposit account resource and the customer.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
updatedAtOptional
RFC3339 Date string
Optional. The date the resource was updated.
name
string
Name of the account holder.
depositProduct
string
The name of the deposit product.
routingNumber
string
Routing number of account.
accountNumber
string
Account number, together with the
routingNumber forms the identifier of the account on the ACH network.currency
string
Currency of the account.
balance
integer
The balance amount (in cents). The balance represents the funds that are currently in the account (not taking into account future commitments). The balance equals the sum of 'available' and 'hold'.
hold
integer
The hold amount (in cents). The hold represents funds that are not available for spending, due to an outstanding card authorization.
available
integer
The available balance for spending (in cents). Equals the balance minus the hold amount.
status
string
Status of the account, either
Open, Frozen, or Closed.interestTerms
The interest terms of the deposit account. Only available if
extraFields[account] is used when calling the Get Account by Id endpoint.freezeReasonOptional
string
Optional. The reason the account was frozen, either
Fraud, ByBank, or free-text description.closeReasonOptional
string
Optional. The reason the account was closed, either
ByCustomer,Fraud or ByBank.fraudReasonOptional
string
Optional. The expanded fraud reason for closing the account when
Fraud is specified as the reason. Can be one of: (ACHActivity, CardActivity, CheckActivity, ApplicationHistory, AccountActivity, ClientIdentified, IdentityTheft, LinkedToFraudulentCustomer).dacaStatusOptional
string
Optional. The account DACA (Deposit Account Control Agreements) status. Can be one of:
Entered, Activated.Note
The currency is currently always set to USD. The balance, hold and available amounts are represented in cents.
Relationships
customers
Optional, populated if account has multiple owners.
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"
}
}
}
}
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:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
dishonoredAchTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account and customer).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
description
string
Transaction description.
companyName
string
The name by which the originator is known to the receiver.
counterpartyRoutingNumber
string
The routing number of the party that originated the ACH payment.
traceNumber
string
The ACH Trace Number.
reason
string
The reason for the dishonored return.
secCodeOptional
string
Optional. The 3-letter ACH Standard Entry Class (SEC) Code (e.g.
WEB, CCD, PPD, etc.).Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example 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"
}
}
}
}
Dispute
Dispute is a JSON:API resource, top-level fields:
id
string
Identifier of the Dispute resource.
type
string
Type of the Dispute resource. The value is always
dispute.attributes
JSON Object
JSON object representing the Dispute data.
relationships
JSON:API Relationships
Describes relationships between the Dispute resource and other resources.
Attributes
source
string
One of
DebitCard or ACHstatus
string
One of
InvestigationStarted, ProvisionallyCredited, Denied, ResolvedLost, ResolvedWon.statusHistory
Array of dispute statuses
A dispute status list with the status date. Possible statuses are
InvestigationStarted, ProvisionallyCredited, Denied, ResolvedLost, ResolvedWon.description
string
Dispute description.
createdAt
RFC3339 Date string
The date the resource was created.
updatedAtOptional
RFC3339 Date string
Optional. The date the resource was updated.
amount
string
The amount (cents) of the payment.
decisionReasonOptional
string
Optional. Reason for a
ResolvedLost status.disputeTypeOptional
string
Optional. One of
Issuer, Fraud, NonFraud.Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
card
Optional, JSON:API Relationship
The card the resource belongs to. This relationship is only available if the transaction is a card operation.
Example Dispute resource:
{
"data": {
"type": "dispute",
"id": "36",
"attributes": {
"source": "DebitCard",
"statusHistory": [
{
"type": "InvestigationStarted",
"updatedAt": "2022-02-23T12:15:47.386Z"
}
],
"status": "InvestigationStarted",
"description": "Debit card transaction",
"disputeType": "Fraud",
"createdAt": "2022-02-23T12:15:47.386Z",
"amount": 5000,
"decisionReason": null
},
"relationships": {
"customer": {
"data": {
"type": "customer",
"id": "10001"
}
},
"account": {
"data": {
"type": "account",
"id": "10002"
}
},
"transaction": {
"data": {
"type": "transaction",
"id": "10003"
}
},
"card": {
"data": {
"type": "card",
"id": "10004"
}
}
}
}
}
Dispute Transaction
DisputeTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
disputeTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account, customer, disputedTransaction).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
disputeId
string
Unique ID of the dispute that is related to the transaction.
summary
string
Summary of the transaction. Common to all transaction types.
reason
string
The reason for the dispute transaction, one of:
ProvisionalCredit, ProvisionalCreditReversalDenied, ProvisionalCreditReversalResolved, FinalCredit.Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example 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"
}
}
}
}
Event
Event is a JSON:API resource, top-level fields:
id
string
Identifier of the event resource.
type
string
Type of the event resource.
relationships
JSON:API Relationships
Describes relationships between the event resource and other resources, based on the event type. See Events.
Example Event resource:
{
"data": [
{
"id": "230",
"type": "transaction.created",
"attributes": {
"createdAt": "2021-03-15T07:49:09.089Z",
"amount": 10000,
"direction": "Credit",
"summary": "Wire to Jane Smith"
},
"relationships": {
"account": {
"data": {
"id": "10005",
"type": "account"
}
},
"transaction": {
"data": {
"id": "189",
"type": "wireTransaction"
}
},
"customer": {
"data": {
"id": "10000",
"type": "individualCustomer"
}
}
}
}
]
}
Existing Customer Credit Application
ExistingCustomerCreditApplication is a JSON:API resource, top-level fields:
id
string
Identifier of the application resource.
type
string
Type of the credit application resource. For existingCustomerCreditApplication the value is always
existingCustomerCreditApplication.attributes
JSON Object
JSON object representing the credit application data.
relationships
JSON:API Relationships
Describes relationships between the credit application resource and other resources.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
status
string
The status of the credit application. One of
Created, Pending, Approved, Denied, Canceled.aggregatorAccessTokensOptional
Array of string
Optional. Array of aggregator access tokens which are Plaid (or other account linking platform) integration tokens. See Plaid processor token
annualIncomeOptional
Integer (Cents)
Optional. The annual income of the applicant.
yearsInBusinessOptional
Integer
Optional. Number of years the business has been in operation.
additionalUnderwritingDataOptional
json
Optional. Object containing key-value pairs of underwriting data per credit policy.
Relationships
lendingProgram
JSON:API Relationship
The LendingProgram to which this credit application is related to.
Example existingCustomerCreditApplication resource:
{
"data": {
"type": "existingCustomerCreditApplication",
"id": "12",
"attributes": {
"createdAt": "2024-02-18T12:33:32.158Z",
"status": "Pending",
"aggregatorAccessTokens": [],
"annualIncome": 1,
"numberOfEmployees": "One",
"yearsInBusiness": 4,
"additionalUnderwritingData": {
"dad": "dada"
}
},
"relationships": {
"customer": {
"data": {
"type": "customer",
"id": "10002"
}
},
"lendingProgram": {
"data": {
"type": "lendingProgram",
"id": "1"
}
}
}
}
}
External Repayment
externalRepayment is a JSON:API resource, top-level fields:
id
string
Identifier of the external repayment resource.
type
string
Type of the repayment resource. For external repayment the value is
externalRepayment.attributes
JSON Object
JSON object representing the repayment resource.
relationships
JSON:API Relationships
Describes relationships between the external repayment and the credit account.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
updatedAt
RFC3339 Date string
The date the resource was updated.
amount
integer
The amount (cents) of the repayment.
status
string
The status of the external repayment. One of
Sent or Returned.description
string
Repayment description.
Relationships
customer
Optional, JSON:API Relationship
The Customer the credit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
Example externalRepayment resource:
{
"data": {
"type": "externalRepayment",
"id": "1",
"attributes": {
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z",
"amount": 50000,
"status": "Sent",
"description": "External payment"
},
"relationships": {
"org": {
"data": {
"type": "org",
"id": "1"
}
},
"creditAccount": {
"data": {
"type": "creditAccount",
"id": "10007"
}
},
"customer": {
"data": {
"type": "customer",
"id": "10002"
}
}
}
}
}
Fee
Fee is a JSON:API resource, top-level fields:
id
string
Identifier of the fee resource.
type
string
Type of the fee resource. The value is always
fee.attributes
JSON Object
JSON object representing the fee data.
relationships
JSON:API Relationships
Describes relationships between the fee resource and other resources (accounts).
Attributes
amount
integer
The amount (in cents) of the fee.
description
string
Description of the fee.
Relationships
Example Fee resource:
{
"data": {
"type": "fee",
"id": "1234",
"attributes": {
"amount": 1000,
"description": "Monthly Subscription"
},
"relationships": {
"account": {
"data": {
"type": "depositAccount",
"id": "10097"
}
}
}
}
}
Fee Reversal Transaction
FeeReversalTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
feeReversalTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account, customer and relatedTransaction).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example FeeReversalTransaction resource:
{
"data": {
"type": "feeReversalTransaction",
"id": "265",
"attributes": {
"createdAt": "2021-06-06T07:23:30.101Z",
"amount": 200,
"direction": "Debit",
"balance": 3716500,
"summary": "Reversal fee transaction for #122 | Moves Card Replacement Fee"
},
"relationships": {
"account": {
"data": {
"type": "account",
"id": "10001"
}
},
"customer": {
"data": {
"type": "customer",
"id": "10000"
}
},
"relatedTransaction": {
"data": {
"type": "transaction",
"id": "122"
}
}
}
}
}
Fee Transaction
FeeTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
feeTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account, customer and relatedTransaction).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
relatedTransactionOptional
JSON:API Relationship
Optional. 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"
}
}
}
}
FeeReversal
FeeReversal is a JSON:API resource, top-level fields:
id
string
Identifier of the fee resource.
type
string
Type of the fee resource. The value is always
feeReversal.attributes
JSON Object
JSON object representing the fee data.
relationships
JSON:API Relationships
Describes relationships between the fee resource and other resources (accounts).
Attributes
description
string
Description of the fee.
Relationships
Example FeeReversal resource:
{
"data": {
"type": "fee reversal",
"attributes": {
"description": "Monthly Subscription - reverse"
},
"relationships": {
"account": {
"data": {
"type": "depositAccount",
"id": "10097"
}
},
"transaction": {
"data": {
"type": "transaction",
"id": "1"
}
}
}
}
}
FinancialBusinessFBOAccount
FinancialBusinessFBOAccount is a JSON:API resource, top-level fields:
id
string
Identifier of the deposit account resource.
type
string
Type of the resource, the value is always
financialBusinessFBOAccount.attributes
JSON Object
JSON object representing the financial business fbo account data.
relationships
JSON:API Relationships
Describes relationships between the financial business fbo account resource and the customer.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
updatedAtOptional
RFC3339 Date string
Optional. The date the resource was updated.
name
string
The offical name.
depositProduct
string
The name of the deposit product.
routingNumber
string
Routing number of account.
accountNumber
string
Account number, together with the
routingNumber forms the identifier of the account on the ACH network.currency
string
Currency of the account.
balance
integer
The balance amount (in cents). The balance represents the funds that are currently in the account (not taking into account future commitments). The balance equals the sum of 'available' and 'hold'.
hold
integer
The hold amount (in cents). The hold represents funds that are not available for spending, due to an outstanding card authorization.
available
integer
The available balance for spending (in cents). Equals the balance minus the hold amount.
status
string
Status of the account, either
Open, Frozen, or Closed.freezeReasonOptional
string
Optional. The reason the account was frozen, either
Fraud, ByBank, or free-text description.closeReasonOptional
string
Optional. The reason the account was closed, either
ByCustomer or Fraud.fraudReasonOptional
string
Optional. The expanded fraud reason for closing the account when
Fraud is specified as the reason. Can be one of: (ACHActivity, CardActivity, CheckActivity, ApplicationHistory, AccountActivity, ClientIdentified, IdentityTheft, LinkedToFraudulentCustomer).dacaStatusOptional
string
Optional. The account DACA (Deposit Account Control Agreements) status. Can be one of:
Entered, Activated.Note
The currency is currently always set to USD. The balance, hold and available amounts are represented in cents.
Relationships
Example FinancialBusinessFBOAccount Resource:
{
"type": "financialBusinessFBOAccount",
"id": "1",
"attributes": {
"createdAt": "2023-07-12T10:19:30.409Z",
"name": "Thread Bank for the benefit of Pied Piper Inc.",
"status": "Open",
"depositProduct": "checking",
"routingNumber": "812345678",
"accountNumber": "1000000002",
"currency": "USD",
"balance": 10000,
"hold": 0,
"available": 10000,
"tags": {
"purpose": "fbo"
}
},
"relationships": {
"customer": {
"data": {
"type": "customer",
"id": "8"
}
}
}
}
IIAS Authorization Request V2
IIAS Authorization Request V2 is a JSON:API resource, top-level fields:
type
string
Type of the authorization request resource. The value is always
pendingAuthorizationRequest.id
string
The authorization request id
attributes
JSON Object
JSON object representing the authorization request data.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
available
integer
The available balance for spending (in cents).
status
string
The status of the request. will be always "Pending"
partialApprovalAllowed
boolean
Indicates whether the authorization request supports partial amount approval.
merchant.name
string
The name of the merchant.
merchant.type
integer
The 4-digit ISO 18245 merchant category code (MCC).
merchant.locationOptional
string
Optional. The location (city, state, etc.) of the merchant.
merchant.idOptional
string
Optional. The unique network merchant identifier.
recurring
boolean
Indicates whether the authorization is recurring
direction
string
The direction in which the funds flow (either
Debit or Credit).mustBeApproved
boolean
Indicates whether the authorization request must be approved.
paymentMethodOptional
string
Optional. The payment method used, one of:
Manual, Swipe, Contactless, ChipAndPin, Stored, Other.ecommerceOptional
boolean
Optional. Indicates whether the transaction was created over an electronic network (primarily the internet).
cardPresentOptional
boolean
Optional. Indicates whether the card was present when the transaction was created.
currencyConversionOptional
Optional. When original currency for transaction is not USD.
isInternationalOptional
boolean
Optional. Indicates whether the transaction is international.
cardNetworkOptional
string
Optional. The network that this card is a part of, e.g. Visa, Interlink, etc.
Example IIAS Authorization Request V2 resource:
{
"data": [
{
"id": "412",
"type": "pendingAuthorizationRequest",
"attributes": {
"createdAt": "2021-06-24T08:10:08.081Z",
"amount": 2000,
"available": 150000,
"status": "Pending",
"partialApprovalAllowed": true,
"merchant": {
"name": "Merchant name",
"type": "6012"
},
"recurring": false,
"ecommerce": true,
"cardPresent": false,
"healthCareAmounts": {
"transitAmount": 0,
"prescriptionRXAmount": 0,
"visionOpticalAmount": 2000,
"clinicOtherQualifiedMedicalAmount": 0,
"dentalAmount": 0,
"totalHealthcareAmount": 2000
},
"direction": "Debit",
"mustBeApproved": false,
"tags": {
"tag": "value"
},
"idempotencyKey": "9345cd5e-3110-48bb-8b8c-09b3b714164e",
"currencyConversion": {
"originalCurrency": "EUR",
"amountInOriginalCurrency": 1000,
"fxRate": "1.164"
},
"isInternational": true,
"cardNetwork": "Visa"
},
"relationships": {
"authorizationRequest": {
"data": {
"id": "6",
"type": "purchaseAuthorizationRequest"
}
},
"account": {
"data": {
"id": "10001",
"type": "account"
}
},
"customer": {
"data": {
"id": "10000",
"type": "customer"
}
},
"card": {
"data": {
"id": "7",
"type": "card"
}
}
}
}
]
}
IndividualApplication
IndividualApplication is a JSON:API resource, top-level fields:
id
string
Identifier of the application resource.
type
string
Type of the application resource. For individual application the value is always
individualApplication.attributes
JSON Object
JSON object representing the application data.
relationships
JSON:API Relationships
Describes relationships between the application resource and other resources (documents).
Attributes
status
string
message
string
A message describing the
IndividualApplication status.createdAt
RFC3339 Date string
The date the resource was created.
updatedAtOptional
RFC3339 Date string
Optional. The date the resource was updated.
ssn
string
SSN of the individual (numbers only). Either
ssn or passport will be populated.passport
string
Individual passport number. Either
ssn or passport will be populated.nationalityOptional
ISO31661-Alpha2 string
Always when Passport is populated and optional when SSN is populated. Two letters representing the individual nationality (e.g.
"US").dateOfBirth
RFC3339 Date string
Date only (e.g.
"2001-08-15").email
string
Email address of the individual.
ip
string
IP address of the end-customer creating the application, if specified.
soleProprietorshipOptional
boolean
Optional. Indicates whether the individual is a sole proprietor, if specified.
einOptional
string
Optional. Indicates if the individual is a sole proprietor who has an Employer Identification Number, if specified.
industryOptional
Optional. Industry
Optional. Indicates if the individual is a sole proprietor who has a business industry, if specified.
dbaOptional
string
Optional. Indicates if the individual is a sole proprietor who is doing business under a different name, if specified.
archived
boolean
Indicates whether the application has been archived. Archived applications are read-only and no changes can be made to them. Once an application has been archived, a new application with the same SSN (or Passport) may be submitted. An application becomes archived once the corresponding customer is archived.
idTheftScoreOptional
number
Optional. Score (0-1000) for ID theft verification, >900 is auto rejected as default (threshold is configurable).
Relationships
customerOptional
JSON:API Relationship
Optional. The created
Customer in case of approved application.applicationFormOptional
JSON:API Relationship
Optional. 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"
}
}
}
}
IndividualCustomer
IndividualCustomer is a JSON:API resource, describing the individual customer. Top-level fields:
id
string
Identifier of the individual resource.
type
string
Type of the resource, the value is always
individualCustomer.attributes
JSON Object
JSON object representing the individual data.
relationships
JSON:API Relationships
Describes relationships between the customer resource, the
Org it belongs to, and the Application it was created by.createdAt
RFC3339 Date string
The date the resource was created.
ssn
string
Individual passport number. Either
ssn or passport will be populated.passport
string
Individual passport number. Either
ssn or passport will be populated.nationalityOptional
ISO31661-Alpha2 string
Always when Passport is populated and optional when SSN is populated. Two letters representing the individual nationality (e.g.
"US").dateOfBirth
RFC3339 Date string
Date only (e.g.
"2001-08-15").email
string
Email address of the individual.
authorizedUsers
Array of AuthorizedUser
Array of authorized users. An authorized user is someone who can participate in the One Time Password (OTP) authentication process.
status
string
Status of the customer, either
Active, Archived. You can't do any write operations with Archived customers.einOptional
string
Optional. Indicates if the individual is a sole proprietor who has an Employer Identification Number, if specified.
archiveReasonOptional
string
Optional. The reason the account was archived, can be one of
ByBank, Inactive, FraudACHActivity, FraudCardActivity, FraudCheckActivity, FraudApplicationHistory, FraudAccountActivity, FraudClientIdentified, FraudLinkedToFraudulentCustomer.Relationships
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",
"eligibleProducts": [
"Banking",
"BillPay"
],
"tags": {
"userId": "106a75e9-de77-4e25-9561-faffe59d7814"
},
"authorizedUsers": [
{
"fullName": {
"first": "Erlich",
"last": "Backman"
},
"email": "erlich-backman@piedpiper.com",
"phone": {
"countryCode": "1",
"number": "1234567890"
},
"canConnectWithAuthVendor": true
},
{
"fullName": {
"first": "Nelson",
"last": "Bighetti"
},
"email": "nelson-bighetti@piedpiper.com",
"phone": {
"countryCode": "1",
"number": "1234567891"
},
"canConnectWithAuthVendor": false
}
]
},
"relationships": {
"org": {
"data": {
"type": "org",
"id": "1"
}
},
"application": {
"data": {
"type": "individualApplication",
"id": "8"
}
},
"authorizedUserResources": {
"data": [
{
"type": "authorizedUserResource",
"id": "1"
},
{
"type": "authorizedUserResource",
"id": "2"
}
]
}
}
}
IndividualDebitCard
IndividualDebitCard is a JSON:API resource, top-level fields:
id
string
Identifier of the card resource.
type
string
Type of the card resource. For individual debit card the value is always
individualDebitCard.attributes
JSON Object
JSON object representing the card data.
relationships
JSON:API Relationships
Describes relationships between the card resource and other resources (account and customer).
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
updatedAtOptional
RFC3339 Date string
Optional. The date the resource was updated.
last4Digits
string
Last 4 digits of the debit card.
expirationDate
string
Card expiration date, formatted
YYYY-MM, e.g "2020-05".bin
string
9-digit Bank Identification Number (BIN).
status
string
Status of the card, one of:
Active, Inactive, Stolen, Lost, Frozen, ClosedByCustomer, SuspectedFraud.designOptional
string
Optional. Card design, if specified.
Relationships
Example IndividualDebitCard resource:
{
"type": "individualDebitCard",
"id": "8",
"attributes": {
"createdAt": "2020-05-13T09:07:47.645Z",
"last4Digits": "1234",
"expirationDate": "2022-05",
"bin": "123456789",
"shippingAddress": {
"street": "5230 Newell Rd",
"street2": null,
"city": "Palo Alto",
"state": "CA",
"postalCode": "94303",
"country": "US"
},
"status": "Active"
},
"relationships": {
"account": {
"data": {
"type": "depositAccount",
"id": "2"
}
},
"customer": {
"data": {
"type": "individualCustomer",
"id": "2"
}
}
}
}
IndividualVirtualDebitCard
IndividualVirtualDebitCard is a JSON:API resource, top-level fields:
id
string
Identifier of the card resource.
type
string
Type of the card resource. For individual virtual debit card the value is always
individualVirtualDebitCard.attributes
JSON Object
JSON object representing the card data.
relationships
JSON:API Relationships
Describes relationships between the card resource and other resources (account and customer).
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
updatedAtOptional
RFC3339 Date string
Optional. The date the resource was updated.
last4Digits
string
Last 4 digits of the debit card.
expirationDate
string
Card expiration date, formatted
YYYY-MM, e.g "2020-05".bin
string
9-digit Bank Identification Number (BIN).
status
string
Status of the card, one of:
Active, Inactive, Stolen, Lost, Frozen, ClosedByCustomer, SuspectedFraud.Relationships
Example IndividualVirtualDebitCard resource:
{
"type": "individualVirtualDebitCard",
"id": "8",
"attributes": {
"createdAt": "2020-05-13T09:07:47.645Z",
"last4Digits": "1234",
"expirationDate": "2022-05",
"bin": "123456789",
"status": "Active"
},
"relationships": {
"account": {
"data": {
"type": "depositAccount",
"id": "2"
}
},
"customer": {
"data": {
"type": "individualCustomer",
"id": "2"
}
}
}
}
Institution
Institution is a JSON:API resource, top-level fields:
type
string
Type of the institution resource. The value is always
institution.attributes
JSON Object
JSON object representing the institution data.
Attributes
name
string
Name of the institution.
addressOptional
string
Optional. Address of the institution.
isACHSupported
boolean
Is FedACH participant.
isWireSupported
boolean
Is Fedwire participant.
Example Institution resource:
{
"type": "institution",
"attributes": {
"routingNumber": "091311229",
"name": "Choice Financial Group",
"address": "Ste 300 Fargo ND 58104",
"isACHSupported": true,
"isWireSupported": false
}
}
Interest Share Transaction
interestShareTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
interestShareTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account, customer and org).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example 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"
}
}
}
}
}
Interest Transaction
InterestTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
interestTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account and customer).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example 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"
}
}
}
}
Lending Program
Bank Sponsored Lending Program
bankSponsoredChargeCardProgram is a JSON:API resource, top-level fields:
type
string
Type of the lending program. The value is always
bankSponsoredChargeCardProgram.id
string
The lending program id
attributes
JSON Object
JSON object representing the lending program data.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
name
String
The name of the lending program
programSizeLimit
Integer (Cents)
Example bankSponsoredChargeCardProgram resource:
{
"data": {
"type": "bankSponsoredChargeCardProgram",
"id": "12",
"attributes": {
"createdAt": "2024-02-16T16:32:11.741Z",
"name": "Unit Finance Inc - MyBank BankSponsored Lending Program",
"programSizeLimit": 10900000
}
}
}
Client Sponsored Lending Program
clientSponsoredChargeCardProgram is a JSON:API resource, top-level fields:
type
string
Type of the lending program. The value is always
clientSponsoredChargeCardProgram.id
string
The lending program id
attributes
JSON Object
JSON object representing the lending program data.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
name
String
The name of the lending program
programSizeLimit
Integer (Cents)
Example clientSponsoredChargeCardProgram resource:
{
"data": {
"type": "clientSponsoredChargeCardProgram",
"id": "12",
"attributes": {
"createdAt": "2024-02-16T16:32:11.741Z",
"name": "Unit Finance Inc - MyBank ClientSponsored Lending Program",
"programSizeLimit": 10900000
}
}
}
Receivables Retention Lending Program
receivablesRetentionProgram is a JSON:API resource, top-level fields:
type
string
Type of the lending program. The value is always
receivablesRetentionProgram.id
string
The lending program id
attributes
JSON Object
JSON object representing the lending program data.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
name
String
The name of the lending program
programSizeLimit
Integer (Cents)
Example receivablesRetentionProgram resource:
{
"data": {
"type": "receivablesRetentionProgram",
"id": "12",
"attributes": {
"createdAt": "2024-02-16T16:32:11.741Z",
"name": "Unit Finance Inc - My Receivables Retention Lending Program",
"programSizeLimit": 10900000
}
}
}
Lending Program Extended Information
lendingProgramExtendedInformation is a JSON:API resource, top-level fields:
type
string
Type of the resource. The value is always
lendingProgramExtendedInformation.id
string
The lending program id
attributes
JSON Object
JSON object representing the lending program extended information data.
Attributes
programSizeAvailable
Integer (Cents)
description
programSizeAllocated
Integer (Cents)
description
Example lendingProgramExtendedInformation resource:
{
"data": {
"type": "lendingProgramExtendedInformation",
"id": "12",
"attributes": {
"programSizeAvailable": 10899600,
"programSizeAllocated": 400
}
}
}
MobileWalletPayload
MobileWalletPayload is a JSON:API resource, top-level fields:
type
string
Type of the MobileWalletPayload resource. The value is always
mobileWalletPayload.attributes
JSON Object
JSON object representing the MobileWalletPayload data.
Attributes
payload
string
Encrypted payload.
Example MobileWalletPayload resource:
{
"data": {
"type": "mobileWalletPayload",
"attributes": {
"payload": "eyJhbGciOi..."
}
}
}
Negative Balance Coverage Transaction
negativeBalanceCoverageTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
negativeBalanceCoverageTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account, customer and relatedTransaction).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example 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"
}
]
}
}
}
Onboarding Credit Application
OnboardingCreditApplication is a JSON:API resource, top-level fields:
id
string
Identifier of the application resource.
type
string
Type of the credit application resource. For onboardingCreditApplication the value is always
onboardingCustomerCreditApplication.attributes
JSON Object
JSON object representing the credit application data.
relationships
JSON:API Relationships
Describes relationships between the credit application resource and other resources.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
status
string
The status of the credit application. One of
Created, Pending, Approved, Denied, Canceled.aggregatorAccessTokensOptional
Array of string
Optional. Array of aggregator access tokens which are Plaid (or other account linking platform) integration tokens. See Plaid processor token
annualIncomeOptional
Integer (Cents)
Optional. The annual income of the applicant.
yearsInBusinessOptional
Integer
Optional. Number of years the business has been in operation.
additionalUnderwritingDataOptional
json
Optional. Object containing key-value pairs of underwriting data per credit policy.
Relationships
lendingProgram
JSON:API Relationship
The LendingProgram to which this credit application is related to.
Example onboardingCreditApplication resource:
{
"data": {
"type": "onboardingCustomerCreditApplication",
"id": "10",
"attributes": {
"createdAt": "2024-02-18T11:19:44.838Z",
"status": "Created",
"aggregatorAccessTokens": [],
"annualIncome": null,
"numberOfEmployees": null,
"yearsInBusiness": null,
"additionalUnderwritingData": null
},
"relationships": {
"application": {
"data": {
"type": "application",
"id": "10002"
}
},
"lendingProgram": {
"data": {
"type": "lendingProgram",
"id": "1"
}
}
}
}
}
Originated ACH Transaction
OriginatedAchTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
originatedAchTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account and customer).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
description
string
Transaction description.
addendaOptional
string
Optional, additional transaction description.
secCode
string
The 3-letter ACH Standard Entry Class (SEC) Code. One of
WEB, CCD, PPD.traceNumberOptional
string
Optional. The 15-digit ACH Trace Number identifies the transaction within the ACH file after transmission.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example 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"
}
}
}
}
Payment Advance Transaction
PaymentAdvanceTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
paymentAdvanceTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account, customer, receivedPayment).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types. The value is always
Debit.amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
receivedPayment
JSON:API Relationship
The ReceivedPayment that was advanced and funded with this transaction.
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"
}
}
}
}
}
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:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
paymentCanceledTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account, customer).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example 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"
}
}
}
}
PinStatus
PinStatus is a JSON:API resource, top-level fields:
type
string
Type of the PinStatus resource. The value is always
pinStatus.attributes
JSON Object
JSON object representing the PinStatus data.
Attributes
status
string
Status of the PIN, either
Set or NotSet.Example PinStatus resource:
{
"data": {
"type": "pinStatus",
"attributes": {
"status": "NotSet"
}
}
}
Purchase Authorization Request
PurchaseAuthorizationRequest is a JSON:API resource, top-level fields:
id
string
Identifier of the purchase authorization request resource.
type
string
Type of the purchase authorization request resource. The value is always
purchaseAuthorizationRequest.attributes
JSON Object
JSON object representing the authorization request data.
relationships
JSON:API Relationships
Describes relationships between the authorization request resource and other resources (account, customer and card).
Attributes
createdAt
RFC3339 Date string
The date the authorization request was created.
amount
integer
The amount (cents) of the authorization request.
status
string
The status of the authorization request. Either
Pending, Approved or Declined.partialApprovalAllowed
boolean
Indicates whether the authorization request supports partial amount approval.
approvedAmountOptional
integer
Optional. The amount (cents) that was approved. Available only when status is
Approved.declineReasonOptional
string
Optional. The reason the authorization request was declined. One of
AccountClosed, CardExceedsAmountLimit, DoNotHonor, InsufficientFunds, InvalidMerchant, ReferToCardIssuer, RestrictedCard, Timeout, TransactionNotPermittedToCardholder. Available only when status is Declinedmerchant.name
string
The name of the merchant.
merchant.type
integer
The 4-digit ISO 18245 merchant category code (MCC).
merchant.category
string
The merchant category, described by the MCC code (see this reference for the list of category descriptions).
merchant.locationOptional
string
Optional. The location (city, state, etc.) of the merchant.
merchant.idOptional
string
Optional. The unique network merchant identifier.
recurring
boolean
Indicates whether the authorization is recurring
ecommerceOptional
boolean
Optional. Indicates whether the transaction was created over an electronic network (primarily the internet).
cardPresentOptional
boolean
Optional. Indicates whether the card was present when the transaction was created.
paymentMethodOptional
string
Optional. The payment method used, one of:
Manual, Swipe, Contactless, ChipAndPin, Stored, Other.digitalWalletOptional
string
Optional. The type of digital wallet used, one of:
Google, Apple, Other.cardVerificationData. verificationMethodOptional
string
Optional. The verification method used, one of:
Address, CVV2, AddressAndCVV2.cardNetworkOptional
string
Optional. The card network used, one of:
Visa, Interlink, Accel, Allpoint, Other.cashWithdrawalAmountOptional
integer
Optional. Cash withdrawal amount
currencyConversionOptional
Optional. When original currency for transaction is not USD.
isInternationalOptional
boolean
Optional. Indicates whether the transaction is international.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
fundingAccount
Optional, JSON:API Relationship
An 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",
"currencyConversion": {
"originalCurrency": "EUR",
"amountInOriginalCurrency": 1000,
"fxRate": "1.164"
},
"isInternational": true
},
"relationships": {
"customer": {
"data": {
"type": "customer",
"id": "10000"
}
},
"account": {
"data": {
"type": "account",
"id": "10001"
}
},
"card": {
"data": {
"type": "card",
"id": "7"
}
}
}
}
Purchase Authorization Request V2
Purchase Authorization Request V2 is a JSON:API resource, top-level fields:
type
string
Type of the authorization request resource. The value is always
pendingAuthorizationRequest.id
string
The authorization request id
attributes
JSON Object
JSON object representing the authorization request data.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
available
integer
The available balance for spending (in cents).
status
string
The status of the request. will be always "Pending"
partialApprovalAllowed
boolean
Indicates whether the authorization request supports partial amount approval.
merchant.name
string
The name of the merchant.
merchant.type
integer
The 4-digit ISO 18245 merchant category code (MCC).
merchant.locationOptional
string
Optional. The location (city, state, etc.) of the merchant.
merchant.idOptional
string
Optional. The unique network merchant identifier.
recurring
boolean
Indicates whether the authorization is recurring
direction
string
The direction in which the funds flow (either
Debit or Credit).mustBeApproved
boolean
Indicates whether the authorization request must be approved.
paymentMethodOptional
string
Optional. The payment method used, one of:
Manual, Swipe, Contactless, ChipAndPin, Stored, Other.ecommerceOptional
boolean
Optional. Indicates whether the transaction was created over an electronic network (primarily the internet).
cardPresentOptional
boolean
Optional. Indicates whether the card was present when the transaction was created.
currencyConversionOptional
Optional. When original currency for transaction is not USD.
isInternationalOptional
boolean
Optional. Indicates whether the transaction is international.
cardNetworkOptional
string
Optional. The network that this card is a part of, e.g. Visa, Interlink, etc.
Example Purchase Authorization Request V2 resource:
{
"data": [
{
"id": "412",
"type": "pendingAuthorizationRequest",
"attributes": {
"createdAt": "2021-06-24T08:10:08.081Z",
"amount": 2000,
"available": 150000,
"status": "Pending",
"partialApprovalAllowed": false,
"merchant": {
"name": "Merchant name",
"type": "6012",
"id": "311204598883"
},
"recurring": false,
"ecommerce": true,
"cardPresent": false,
"direction": "Debit",
"mustBeApproved": false,
"tags": {
"tag": "value"
},
"idempotencyKey": "9345cd5e-3110-48bb-8b8c-09b3b714164e",
"currencyConversion": {
"originalCurrency": "EUR",
"amountInOriginalCurrency": 1000,
"fxRate": "1.164"
},
"isInternational": true,
"cardNetwork": "Visa"
},
"relationships": {
"authorizationRequest": {
"data": {
"id": "6",
"type": "purchaseAuthorizationRequest"
}
},
"account": {
"data": {
"id": "10001",
"type": "account"
}
},
"customer": {
"data": {
"id": "10000",
"type": "customer"
}
},
"card": {
"data": {
"id": "7",
"type": "card"
}
}
}
}
]
}
Purchase Transaction
PurchaseTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
purchaseTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account and customer).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
cardLast4Digits
string
The last 4 digits of the debit card involved in the transaction.
merchant.name
string
The name of the merchant.
merchant.type
integer
The 4-digit ISO 18245 merchant category code (MCC).
merchant.category
string
The merchant category, described by the MCC code (see this reference for the list of category descriptions).
merchant.locationOptional
string
Optional. The location (city, state, etc.) of the merchant.
merchant.idOptional
string
Optional. The unique network merchant identifier.
coordinatesOptional
Optional. Coordinates (latitude, longitude) of where the purchase took place.
recurring
boolean
Indicates whether the transaction is recurring.
interchangeOptional
string
Optional. The interchange share for this transaction. Calculated at the end of each day, see the transaction.updated event.
grossInterchangeOptional
string
Optional. The gross interchange share for this transaction.
ecommerce
boolean
Indicates whether the transaction was created over an electronic network (primarily the internet).
cardPresent
boolean
Indicates whether the card was present when the transaction was created.
paymentMethodOptional
string
Optional. The payment method used, one of:
Manual, Swipe, Contactless, ChipAndPin, Stored, Other.digitalWalletOptional
string
Optional. The type of digital wallet used, one of:
Google, Apple, Other.cardVerificationData.verificationMethodOptional
string
Optional. The verification method used, one of:
Address, CVV2, AddressAndCVV2.cardNetworkOptional
string
Optional. The card network used, one of:
Visa, Interlink, Accel, Allpoint, Other.cashWithdrawalAmountOptional
integer
Optional. Cash withdrawal amount
richMerchantDataOptional
Optional. Full merchant information. See Transaction Enrichment.
currencyConversionOptional
Optional. When original currency for transaction is not USD.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
authorizationOptional
JSON:API Relationship
Optional. The Authorization request made by the merchant, if present (see Authorizations).
authorizationRequest
Optional, JSON:API Relationship
The preceding authorization request, if present (see Authorization Requests).
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",
"grossInterchange": "200.00",
"ecommerce": false,
"cardPresent": true,
"paymentMethod": "Contactless",
"digitalWallet": "Apple",
"cardVerificationData": {
"verificationMethod": "CVV2"
},
"cardNetwork": "Visa"
},
"relationships": {
"account": {
"data": {
"type": "account",
"id": "10001"
}
},
"customer": {
"data": {
"type": "customer",
"id": "3"
}
},
"card": {
"data": {
"type": "card",
"id": "11"
}
},
"authorization": {
"data": {
"type": "authorization",
"id": "40"
}
}
}
}
Push To Card Payment
PushToCardPayment is a JSON:API resource, top-level fields:
id
string
Identifier of the push-to-card payment resource.
type
string
Type of the payment resource. The value is always
pushToCardPayment.attributes
JSON Object
JSON object representing the payment resource.
relationships
JSON:API Relationships
Describes relationships between the push-to-card payment resource and other resources .
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
status
string
Either
Pending, Sent or Rejected (see reason for details).reasonOptional
string
Optional. More information about the status.
description
string
Payment description.
amount
string
The amount (cents) of the payment.
astraRoutineIdOptional
string
Optional. In case the payment status is
Sent it is the generated astra routine idRelationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to a multiple individual customers.
Example PushToCardPayment resource:
{
"data": {
"type": "pushToCardPayment",
"id": "4242",
"attributes": {
"createdAt": "2023-03-23T13:56:04.022Z",
"amount": 501,
"direction": "Credit",
"description": "My Unit Account to Card Routine #2",
"status": "Sent",
"astraRoutineId": "c4548932-1243-5z95-bxyc-905014n6ba31"
},
"relationships": {
"account": {
"data": {
"type": "account",
"id": "42"
}
},
"customer": {
"data": {
"type": "customer",
"id": "41"
}
},
"transaction": {
"data": {
"type": "transaction",
"id": "40"
}
},
"org": {
"data": {
"type": "org",
"id": "1"
}
},
"achPayment": {
"data": {
"type": "achPayment",
"id": "43"
}
}
}
}
}
Push To Card Reversal Transaction
PushToCardReversalTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
pushToCardReversalTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources.
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example PushToCardReversalTransaction resource:
{
"data": {
"type": "pushToCardReversalTransaction",
"id": "7",
"attributes": {
"createdAt": "2023-05-22T08:04:43.692Z",
"amount": 500005,
"direction": "Credit",
"balance": 1499947,
"summary": "Push to card transaction reversal for original transaction #6 | My Unit Account to Card Routine #900-5",
"tags": {}
},
"relationships": {
"account": {
"data": {
"type": "account",
"id": "10003"
}
},
"customer": {
"data": {
"type": "customer",
"id": "10003"
}
},
"customers": {
"data": [
{
"type": "customer",
"id": "10003"
}
]
},
"org": {
"data": {
"type": "org",
"id": "1"
}
},
"payment": {
"data": {
"type": "payment",
"id": "1005"
}
},
"originalTransaction": {
"data": {
"type": "originalTransaction",
"id": "6"
}
}
}
}
}
Push To Card Transaction
PushToCardTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
pushToCardTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources.
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example PushToCardTransaction resource:
{
"data": {
"type": "pushToCardTransaction",
"id": "777",
"attributes": {
"createdAt": "2023-03-23T13:56:04.200Z",
"amount": 501,
"direction": "Debit",
"balance": 10619,
"summary": "My Unit Account to Card Routine #2",
"tags": {}
},
"relationships": {
"account": {
"data": {
"type": "account",
"id": "42"
}
},
"customer": {
"data": {
"type": "customer",
"id": "28"
}
},
"customers": {
"data": [
{
"type": "customer",
"id": "19"
}
]
},
"org": {
"data": {
"type": "org",
"id": "1"
}
},
"payment": {
"data": {
"type": "payment",
"id": "68"
}
}
}
}
}
Receivable
receivable is a JSON:API resource, top-level fields:
type
string
Type of the receivable. The value can be one of the following
bankReceivable, orgReceivable, capitalPartnerReceivable.id
string
The receivable id
attributes
JSON Object
JSON object representing the receivable data.
relationships
JSON:API Relationships
Describes relationships between the receivable resource and other resources.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
updatedAt
RFC3339 Date string
The date the resource was updated.
originalAmount
Integer (Cents)
The original amount of the receivable that need to be repaid.
remainingAmount
Integer (Cents)
The remaining amount of the receivable that need to be repaid.
repaymentStatus
JSON Object
JSON Object representing The status of the repayment and last repayment timestamp. The value of the repayment status can be one of the following
notRepaid, partiallyRepaid, fullyRepaid.purchaseDueDateOptional
String
Optional. The date the receivable is due e.g.
2024-12-31.purchasedTimestampOptional
RFC3339 Date string
Optional. The date the receivable was purchased
capitalPartnerIdOptional
String
Optional. The capital partner id
Example receivable resource:
{
"data": {
"type": "bankReceivable",
"id": "5",
"attributes": {
"createdAt": "2024-12-08T08:58:55.515Z",
"updatedAt": "2024-12-08T08:58:55.515Z",
"originalAmount": 100,
"remainingAmount": 100,
"purchaseDueDate": "2023-05-25",
"repaymentStatus": {
"type": "notRepaid"
}
},
"relationships": {
"customer": {
"data": {
"type": "customer",
"id": "10002"
}
},
"account": {
"data": {
"type": "account",
"id": "10027"
}
},
"transaction": {
"data": {
"type": "transaction",
"id": "154"
}
},
"lendingProgram": {
"data": {
"type": "lendingProgram",
"id": "15"
}
}
}
}
}
Receivables Balance
receivables balance is a JSON:API resource, top-level fields:
type
string
The type will be always
receivablesBalance.attributes
JSON Object
JSON object representing the receivable data.
Attributes
pendingPurchaseReceivablesAmount
Integer (Cents)
The remaining amount to be purchased.
purchaseDueDateOptional
String
Optional. The date the receivables are supposed to be purchased e.g.
2024-12-31.Example receivables balance resource:
{
"data": {
"type": "receivablesBalance",
"attributes": {
"pendingPurchaseReceivablesAmount": 100
}
}
}
Received ACH Transaction
ReceivedAchTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
receivedAchTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account and customer).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
description
string
Transaction description.
addendaOptional
string
Optional. Additional transaction description (maximum of 50 characters).
companyName
string
The name by which the originator is known to the receiver.
counterpartyRoutingNumber
string
The routing number of the party that originated the ACH payment.
traceNumber
string
The ACH Trace Number.
secCodeOptional
string
Optional. The 3-letter ACH Standard Entry Class (SEC) Code (e.g.
WEB, CCD, PPD, etc.).Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example 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"
}
}
}
}
Recurring ACH Repayment
recurringAchRepayment is a JSON:API resource, top-level fields:
id
string
Identifier of the recurring ACH repayment resource.
type
string
Type of the recurring repayment resource. For recurring ach repayment the value is
recurringAchRepayment.attributes
JSON Object
JSON object representing the recurring repayment resource.
relationships
JSON:API Relationships
Describes relationships between the Recurring ACH repayment and the originating deposit account, counterparty, credit account, customer and org.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
updatedAt
RFC3339 Date string
The date the resource was updated.
description
string
Repayment description (maximum of 50 characters). this will show up on the statement of the counterparty.
addendaOptional
string
Optional, additional payment description (maximum of 80 characters), not all institutions present that.
tagsOptional
object
Optional. See Tags. Tags that will be copied to any transaction that this payment creates (see Tag Inheritance).
numberOfRepayments
integer
Represents the number of repayments that were created by this recurring payment.
status
string
Status of the recurring repayment, one of:
Active, Disabled.Relationships
customerOptional
JSON:API Relationship
Optional. The Customer the credit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
Example AchRepayment resource:
{
"data": {
"type": "recurringAchRepayment",
"id": "2",
"attributes": {
"createdAt": "2024-02-13T11:06:23.680Z",
"schedule": {
"startTime": "2024-02-13",
"interval": "Monthly",
"nextScheduledAction": "2024-03-29",
"dayOfMonth": 29
},
"description": "ACH Repayments",
"sameDay": false,
"numberOfRepayments": 0,
"status": "Active"
},
"relationships": {
"org": {
"data": {
"type": "org",
"id": "2"
}
},
"account": {
"data": {
"type": "account",
"id": "10016"
}
},
"creditAccount": {
"data": {
"type": "creditAccount",
"id": "10005"
}
},
"counterparty": {
"data": {
"type": "counterparty",
"id": "1"
}
},
"customer": {
"data": {
"type": "customer",
"id": "10000"
}
}
}
}
}
Recurring Book Repayment
recurringBookRepayment is a JSON:API resource, top-level fields:
id
string
Identifier of the recurring Book repayment resource.
type
string
Type of the recurring repayment resource. For recurring book repayment the value is
recurringBookRepayment.attributes
JSON Object
JSON object representing the recurring repayment resource.
relationships
JSON:API Relationships
Describes relationships between the Recurring Book repayment and the originating deposit account, counterpartyAccount, credit account, customer and org.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
updatedAt
RFC3339 Date string
The date the resource was updated.
description
string
Repayment description (maximum of 80 characters). this will show up on the statement of the counterparty.
transactionSummaryOverride
string
If this field is populated, its contents will be returned as the bookTransaction's summary field (maximum of 100 characters).
tagsOptional
object
Optional. See Tags. Tags that will be copied to any transaction that this payment creates (see Tag Inheritance).
numberOfRepayments
integer
Represents the number of repayments that were created by this recurring payment.
status
string
Status of the recurring repayment, one of:
Active, Disabled.Relationships
customerOptional
JSON:API Relationship
Optional. The Customer the credit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
Example BookRepayment resource:
{
"data": {
"type": "recurringBookRepayment",
"id": "5",
"attributes": {
"createdAt": "2024-02-13T12:08:20.239Z",
"schedule": {
"startTime": "2024-02-13",
"interval": "Monthly",
"nextScheduledAction": "2024-03-29",
"dayOfMonth": 29
},
"description": "Book Repayments",
"transactionSummaryOverride": "Paid Piper Repayment",
"numberOfRepayments": 0,
"status": "Active"
},
"relationships": {
"org": {
"data": {
"type": "org",
"id": "2"
}
},
"account": {
"data": {
"type": "account",
"id": "10016"
}
},
"creditAccount": {
"data": {
"type": "creditAccount",
"id": "10005"
}
},
"counterpartyAccount": {
"data": {
"type": "account",
"id": "10012"
}
},
"customer": {
"data": {
"type": "customer",
"id": "10000"
}
}
}
}
}
Recurring Capital Partner ACH Repayment
recurringCapitalPartnerAchRepayment is a JSON:API resource, top-level fields:
id
string
Identifier of the recurring ACH repayment resource.
type
string
Type of the recurring repayment resource. For recurring capital partner ach repayment the value is
recurringCapitalPartnerAchRepayment.attributes
JSON Object
JSON object representing the recurring repayment resource.
relationships
JSON:API Relationships
Describes relationships between the Recurring Repayment and the counterparty, credit account, customer and org.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
updatedAt
RFC3339 Date string
The date the resource was updated.
description
string
Repayment description (maximum of 50 characters). this will show up on the statement of the counterparty.
addendaOptional
string
Optional, additional payment description (maximum of 80 characters), not all institutions present that.
tagsOptional
object
Optional. See Tags. Tags that will be copied to any transaction that this payment creates (see Tag Inheritance).
numberOfRepayments
integer
Represents the number of repayments that were created by this recurring payment.
status
string
Status of the recurring repayment, one of:
Active, Disabled.Relationships
customerOptional
JSON:API Relationship
Optional. The Customer the credit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
Example capitalPartnerAchRepayment resource:
{
"data": {
"type": "recurringCapitalPartnerAchRepayment",
"id": "1",
"attributes": {
"createdAt": "2024-02-13T10:54:24.373Z",
"schedule": {
"startTime": "2024-02-13",
"interval": "Monthly",
"nextScheduledAction": "2024-03-29",
"dayOfMonth": 29
},
"description": "Capital partner ACH Repayments",
"sameDay": false,
"numberOfRepayments": 0,
"status": "Active"
},
"relationships": {
"org": {
"data": {
"type": "org",
"id": "1"
}
},
"creditAccount": {
"data": {
"type": "creditAccount",
"id": "10010"
}
},
"counterparty": {
"data": {
"type": "counterparty",
"id": "1"
}
},
"customer": {
"data": {
"type": "customer",
"id": "10001"
}
}
}
}
}
Recurring Capital Partner Book Repayment
recurringCapitalPartnerBookRepayment is a JSON:API resource, top-level fields:
id
string
Identifier of the recurring capital partner Book repayment resource.
type
string
Type of the recurring repayment resource. For recurring capital partner book repayment the value is
recurringCapitalPartnerBookRepayment.attributes
JSON Object
JSON object representing the recurring repayment resource.
relationships
JSON:API Relationships
Describes relationships between the Recurring repayment and the counterpartyAccount, credit account, customer and org.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
updatedAt
RFC3339 Date string
The date the resource was updated.
description
string
Repayment description (maximum of 50 characters). this will show up on the statement of the counterparty.
transactionSummaryOverride
string
If this field is populated, its contents will be returned as the bookTransaction's summary field (maximum of 100 characters).
tagsOptional
object
Optional. See Tags. Tags that will be copied to any transaction that this payment creates (see Tag Inheritance).
numberOfRepayments
integer
Represents the number of repayments that were created by this recurring payment.
status
string
Status of the recurring repayment, one of:
Active, Disabled.Relationships
customerOptional
JSON:API Relationship
Optional. The Customer the credit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
Example capitalPartnerBookRepayment resource:
{
"data": {
"type": "recurringCapitalPartnerBookRepayment",
"id": "5",
"attributes": {
"createdAt": "2024-02-13T12:08:20.239Z",
"schedule": {
"startTime": "2024-02-13",
"interval": "Monthly",
"nextScheduledAction": "2024-03-29",
"dayOfMonth": 29
},
"description": "Book Repayments",
"transactionSummaryOverride": "Paid Piper Repayment",
"numberOfRepayments": 0,
"status": "Active"
},
"relationships": {
"org": {
"data": {
"type": "org",
"id": "2"
}
},
"creditAccount": {
"data": {
"type": "creditAccount",
"id": "10005"
}
},
"counterpartyAccount": {
"data": {
"type": "account",
"id": "10012"
}
},
"customer": {
"data": {
"type": "customer",
"id": "10000"
}
}
}
}
}
Recurring Credit ACH Payment
RecurringCreditAchPayment is a JSON:API resource, top-level fields:
id
string
Identifier of the recurring Credit ACH payment resource.
type
string
Type of the payment resource. For credit ach recurring payments the value is
recurringCreditAchPayment.attributes
JSON Object
JSON object representing the recurring payment resource.
relationships
JSON:API Relationships
Describes relationships between the Recurring Credit ACH payment and the originating deposit account and org.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
updatedAt
RFC3339 Date string
The date the resource was updated.
amount
integer
The amount (cents) of the payment.
description
string
Payment description (maximum of 10 characters), also known as Company Entry Description, this will show up on statement of the counterparty.
addendaOptional
string
Optional, additional payment description (maximum of 80 characters), not all institutions present that.
status
string
Status of the recurring payment, one of:
Active, Completed, Disabled, Deleted.numberOfPayments
integer
Represents the number of payments that were created by this recurring payment.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
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"
}
}
}
}
}
Recurring Credit Book Payment
RecurringCreditBookPayment is a JSON:API resource, top-level fields:
id
string
Identifier of the recurring credit book payment resource.
type
string
Type of the payment resource. The value is always
recurringCreditBookPayment.attributes
JSON Object
JSON object representing the payment resource.
relationships
JSON:API Relationships
Describes relationships between the recurring credit book payment and the originating deposit account and org.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
updatedAt
RFC3339 Date string
The date the resource was updated.
amount
string
The amount (cents) of the payment.
description
string
Payment description (maximum of 80 characters), this will show up on statement of the counterparty.
status
string
Status of the recurring payment, one of:
Active, Completed, Disabled, Deleted.numberOfPayments
integer
Represents the number of payments that were created by this recurring payment.
transactionSummaryOverride
string
If this field is populated, its contents will be returned as the bookTransaction's summary field (maximum of 100 characters).
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
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"
}
}
}
}
}
Recurring Debit ACH Payment
RecurringDebitAchPayment is a JSON:API resource, top-level fields:
id
string
Identifier of the recurring Credit ACH payment resource.
type
string
Type of the payment resource. For credit ach recurring payments the value is
recurringCreditAchPayment.attributes
JSON Object
JSON object representing the recurring payment resource.
relationships
JSON:API Relationships
Describes relationships between the Recurring Credit ACH payment and the originating deposit account and org.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
updatedAt
RFC3339 Date string
The date the resource was updated.
amount
integer
The amount (cents) of the payment.
description
string
Payment description (maximum of 10 characters), also known as Company Entry Description, this will show up on statement of the counterparty.
addendaOptional
string
Optional, additional payment description (maximum of 80 characters), not all institutions present that.
status
string
Status of the recurring payment, one of:
Active, Completed, Disabled, Deleted.numberOfPayments
integer
Represents the number of payments that were created by this recurring payment.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
Example RecurringCreditAchPayment resource:
{
"data": {
"type": "recurringDebitAchPayment",
"id": "1",
"attributes": {
"createdAt": "2022-06-25T08:50:49.391Z",
"updatedAt": "2022-06-25T08:50:49.391Z",
"amount": 1000,
"description": "Rent - Apartment 15",
"schedule": {
"startTime": "2022-06-25",
"interval": "Monthly",
"nextScheduledAction": "2022-07-18",
"dayOfMonth": 16
},
"status": "Active",
"numberOfPayments": 0
},
"relationships": {
"counterparty": {
"data": {
"type": "counterparty",
"id": "1"
}
},
"account": {
"data": {
"type": "account",
"id": "10002"
}
},
"customer": {
"data": {
"type": "customer",
"id": "10004"
}
},
"org": {
"data": {
"type": "org",
"id": "1"
}
}
}
}
}
Release Transaction
ReleaseTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
releaseTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
senderName
string
Name of the sender.
senderAccountNumber
string
Unique identifier to monitor for similar sending accounts, could be the BIN + last four digits of the card number OR a unique identifier generated by you for the sender.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types. The value is always
Credit.description
string
Description of the payment.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
Relationships
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"
}
}
}
}
Repaid Payment Advance Transaction
RepaidPaymentAdvanceTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
repaidPaymentAdvanceTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account, customer, related transaction, receivedPayment).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types. The value is always
Credit.amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
receivedPayment
JSON:API Relationship
The ReceivedPayment that was previously advanced and now completed (and repaid) .
paymentAdvanceTransaction
JSON:API Relationship
The transaction that
Debit the account for the advance that this repayment is related to.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"
}
}
}
}
}
RestrictedResources
RestrictedResources is a JSON:API resource, top-level fields:
ids
Array
Array of resource identifiers.
type
string
Type of the resource. The value is always
account or card.Example RestrictedResources resource:
[
{
"type": "card",
"ids": [
"630",
"529"
]
},
{
"type": "account",
"ids": [
"10000"
]
}
]
Returned ACH Transaction
ReturnedAchTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
returnedAchTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account and customer).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
companyName
string
The name by which the originator is known to the receiver.
counterpartyName
string
The name of the party that originated the ACH payment.
counterpartyRoutingNumber
string
The routing number of the party that originated the ACH payment.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example 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 Check Deposit Transaction
ReturnedCheckDepositTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
returnedCheckDepositTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account, customer, checkDeposit).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
reason
string
The reason for the transaction return.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example 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"
}
}
}
}
}
Returned Check Payment Transaction
ReturnedCheckPaymentTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
returnedCheckPaymentTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account, customer, checkPayment).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
returnReason
string
The reason for the transaction return. This is a replacement to the deprecated
reason attribute.Note
Currently, bot reason and returnReason are supported. Be advised that the values they return are different and that returnReason will soon be deprecated, and reason will be used to return the check payment return reasons as specified in the return reasons list.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example ReturnedCheckPaymentTransaction resource:
{
"type": "returnedCheckPaymentTransaction",
"id": "8",
"attributes": {
"createdAt": "2023-02-21T11:40:55.442Z",
"amount": 299991,
"direction": "Credit",
"balance": 299990,
"summary": "Returned Check Payment transaction #7 due to: Stop Payment",
"returnReason": "StopPayment"
},
"relationships": {
"account": {
"data": {
"type": "account",
"id": "10002"
}
},
"customer": {
"data": {
"type": "customer",
"id": "10005"
}
},
"customers": {
"data": [
{
"type": "customer",
"id": "10005"
}
]
},
"checkPayment": {
"data": {
"type": "checkPayment",
"id": "5"
}
},
"returned": {
"data": {
"type": "transaction",
"id": "7"
}
}
}
}
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:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
returnedReceivedAchTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account and customer).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
companyName
string
The name by which the originator is known to the receiver.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example 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"
}
}
}
}
Returned Wire Transaction
ReturnedWireTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
returnedWireTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account and customer).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
reason
string
The reason for the return.
imad
string
Input Message Accountability Data. It's a unique number given to each FedWire payment in case of payment has been sent and fully processed.
omadOptional
string
Optional. 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
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example ReturnedWireTransaction resource:
{
"data": {
"type": "returnedWireTransaction",
"id": "265",
"attributes": {
"createdAt": "2021-06-06T07:23:30.101Z",
"amount": 200,
"direction": "Debit",
"balance": 3716500,
"summary": "Returned due to: NAMEMISSMATCH | 420 E Polk St., Phoenix, AZ -Part Commission",
"reason": "Insufficient Funds",
"imad": "123456",
"omad": "654321"
},
"relationships": {
"account": {
"data": {
"type": "account",
"id": "10001"
}
},
"customer": {
"data": {
"type": "customer",
"id": "10000"
}
},
"payment": {
"data": {
"type": "payment",
"id": "122"
}
}
}
}
}
Reward
This resource is generated as a result of a reward creation request.
Reward is a JSON:API resource, top-level fields:
id
string
Identifier of the reward resource.
type
string
Type of the reward resource. The value is always
reward.attributes
JSON Object
JSON object representing the reward data.
relationships
JSON:API Relationships
Describes relationships between the reward resource and other resources (accounts, transaction, customer).
Attributes
createdAt
RFC3339 Date string
The date the reward was created.
amount
integer
The amount (in cents) of the reward.
description
string
Description of the reward.
status
string
Either
Sent or Rejected (see rejectReason for details).rejectReasonOptional
string
Optional. More information about the status.
Relationships
cardOptional
JSON:API Relationship
Optional. The card the belongs to the rewardedTransaction (if exists)
Example Reward resource:
{
"type": "reward",
"id": "20",
"attributes": {
"createdAt": "2022-03-31T14:42:55.780Z",
"status": "Sent",
"amount": 4000,
"description": "A sample reward",
"tags": {}
},
"relationships": {
"receivingAccount": {
"data": {
"type": "account",
"id": "10001"
}
},
"fundingAccount": {
"data": {
"type": "account",
"id": "10000"
}
},
"rewardedTransaction": {
"data": {
"type": "transaction",
"id": "7"
}
},
"customer": {
"data": {
"type": "customer",
"id": "10000"
}
},
"transaction": {
"data": {
"type": "transaction",
"id": "24"
}
}
}
}
Reward Transaction
A rewardTransaction represents a successful reward creation.
RewardTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
rewardTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (accounts, customer, reward).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types, this will be the description of the reward.
receiverCounterpartyOptional
Optional. The receiving party of the transaction. Available only when the receiving party is a Deposit Account.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example 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"
}
}
}
}
}
Statement
Statement is a JSON:API resource, top-level fields:
id
string
Identifier of the statement resource.
type
string
Type of the statement resource. The value is always
statement.attributes
JSON Object
JSON object representing the statement data.
relationships
JSON:API Relationships
Describes relationships between the statement resource and other resources (account and customer).
Attributes
period
string
Period of the statement, formatted
YYYY-MM, e.g "2020-05".Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example Statement resource:
{
"type": "statement",
"id": "1",
"attributes": {
"period": "2020-07"
},
"relationships": {
"account": {
"data": {
"type": "account",
"id": "1000"
}
},
"customer": {
"data": {
"type": "customer",
"id": "1"
}
}
}
}
Store Location
Store Location is a JSON:API resource, top-level fields:
type
string
Type of the Store Location resource. The value is always
storeLocation.attributes
JSON Object
JSON object representing the Store Location data.
Attributes
storeId
string
Identifier of the retail store that supports Cash Deposits. This field will be used as
storeId when Creating a Cash Deposit Barcode.retailerName
string
Name of the retail store that supports Cash Deposits.
distance
number
Distance to the retail store (in miles).
Example Store Location resource:
{
"type": "storeLocation",
"attributes": {
"storeId": "4385",
"retailerName": "CVS",
"phone": "5163248587",
"address": {
"street": "38 Pantigo Rd",
"city": "East Hampton",
"state": "NY",
"postalCode": "11937",
"country": "US"
},
"coordinates": {
"longitude": -72.182441,
"latitude": 40.965453
},
"distance": 20.74174506966581
}
}
Tax Form
taxForm is a JSON:API resource, top-level fields:
id
string
Identifier of the tax form resource.
type
string
Type of the tax form resource.
attributes
JSON Object
JSON object representing the statement data.
relationships
JSON:API Relationships
Describes relationships between the tax form resource and other resources (account and customer).
Attributes
formType
string
the type of the tax form.
taxYear
ISO8601 Year string
The tax year of the form, formatted
YYYY, e.g "2020".Relationships
account
Optional. JSON:API Relationship
The account to which the tax form was produced. Available only if the customer to which the form was produced for owns a single account.
accounts
Optional, Array of JSON:API Relationship
The accounts to which the tax form was produced. Only available if the customer to which the tax form was produced owns multiple accounts.
Example Tax Form resource:
{
"type": "taxForm",
"id": "1",
"attributes": {
"formType": "1099-INT",
"taxYear": "2023"
},
"relationships": {
"customer": {
"data": {
"type": "customer",
"id": "10"
}
},
"account": {
"data": {
"type": "account",
"id": "1000"
}
}
}
}
Transaction Card Fraud Case
TransactionCardFraudCase is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction card fraud case resource.
type
string
Type of the transaction card fraud case resource. The value is always
transactionCardFraudCaseattributes
JSON Object
JSON object representing the transaction card fraud case data.
relationships
JSON:API Relationships
Describes relationships between the transaction card fraud case resource and other resources.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
status
string
The status of the card fraud case. Can be one of
Created, Active, Closed, Expired.decision
string
The decision made for the card fraud case. Can be one of
Pending, Fraud, NoFraud.expiresAt
RFC3339 Date string
The date the card fraud case expires.
cardActivities
Array of Fraud Case Card Activity
The card activities associated with the card fraud case.
updatedAtOptional
RFC3339 Date string
Optional. The date the resource was last updated.
Relationships
Example transactionCardFraudCase resource:
{
"data": {
"type": "transactionCardFraudCase",
"id": "9",
"attributes": {
"createdAt": "2024-07-31T11:02:27.355Z",
"status": "Closed",
"decision": "NoFraud",
"expiresAt": "2024-08-03T11:02:27.355Z",
"cardActivities": [
{
"id": "15",
"createdAt": "2024-07-31T11:02:27.355Z",
"activityType": "Authorization",
"cardActivityCreatedAt": "2024-07-31T11:02:27.270Z",
"cardActivity": "8082294",
"location": "Cupertino, CA, US",
"merchant": "Apple Inc.",
"amount": 2500,
"decision": "Fraud",
"updatedAt": "2024-07-31T11:04:43.696Z"
},
{
"id": "16",
"createdAt": "2024-07-31T11:02:27.355Z",
"activityType": "Authorization",
"cardActivityCreatedAt": "2024-07-30T14:40:13.147Z",
"cardActivity": "8069211",
"location": "Cupertino, CA, US",
"merchant": "Apple Inc.",
"amount": 100,
"decision": "NoFraud",
"updatedAt": "2024-07-31T11:04:43.696Z"
},
{
"id": "17",
"createdAt": "2024-07-31T11:02:27.355Z",
"activityType": "Transaction",
"cardActivityCreatedAt": "2024-07-30T14:40:07.534Z",
"cardActivity": "8069210",
"location": "Cupertino, CA, US",
"merchant": "Apple Inc.",
"amount": 100,
"decision": "NoFraud",
"updatedAt": "2024-07-31T11:04:43.696Z"
}
],
"updatedAt": "2024-07-31T11:04:43.696Z"
},
"relationships": {
"card": {
"data": {
"type": "card",
"id": "2200412"
}
},
"account": {
"data": {
"type": "account",
"id": "49230"
}
},
"customer": {
"data": {
"type": "customer",
"id": "49430"
}
},
"transaction": {
"data": {
"type": "transaction",
"id": "8069210"
}
}
}
}
}
WalletAccount
WalletAccount is a JSON:API resource, top-level fields:
id
string
Identifier of the wallet account resource.
type
string
Type of the resource, the value is always
walletAccount.attributes
JSON Object
JSON object representing the wallet account data.
relationships
JSON:API Relationships
Describes relationships between the wallet account resource and the customer.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
name
string
The offical name.
status
string
Status of the account, either
Open, Frozen, or Closed.walletTerms
string
The name of the wallet terms.
routingNumber
string
Routing number of wallet.
accountNumber
string
Account number, together with the
routingNumber forms the identifier of the wallet on the ACH network.currency
string
Currency of the wallet.
balance
integer
The balance amount (in cents). The balance represents the funds that are currently in the wallet (not taking into account future commitments). The balance equals the sum of 'available' and 'hold'.
hold
integer
The hold amount (in cents). The hold represents funds that are not available for spending, due to an outstanding card authorization.
available
integer
The available balance for spending (in cents). Equals the balance minus the hold amount.
freezeReasonOptional
string
Optional. The reason the wallet was frozen, either
Fraud, ByBank, or free-text description.closeReasonOptional
string
Optional. The reason the wallet was closed, either
ByCustomer or Fraud.fraudReasonOptional
string
Optional. The expanded fraud reason for closing the wallet 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
Example WalletAccount Resource:
{
"type": "walletAccount",
"id": "42",
"attributes": {
"createdAt": "2000-05-11T10:19:30.409Z",
"name": "Peter Parker",
"status": "Open",
"walletTerms": "walletDefault",
"routingNumber": "812345678",
"accountNumber": "1000000002",
"currency": "USD",
"balance": 10000,
"hold": 0,
"available": 10000,
"tags": {
"purpose": "Healthcare"
}
},
"relationships": {
"customer": {
"data": {
"type": "customer",
"id": "45555"
}
}
}
}
Webhook
Webhook is a JSON:API resource, top-level fields:
id
string
Identifier of the webhook resource.
type
string
Type of the webhook resource. The value is always
webhook.attributes
JSON Object
JSON object representing the webhook data.
Attributes
createdAt
RFC3339 Date string
The date the webhook
was created.
label | string | A label describing the webhook.
url | string | The URL of the webhook endpoint.
status | string | The status of the webhook. Either Enabled or Disabled.
contentType | string | The type of content you wish to receive. Either Json or JsonAPI.
deliveryMode | string | The attempted delivery mode of the webhook. Either AtMostOnce or AtLeastOnce.
token | string | The secret token (see Securing your webhooks).
Example Webhook resource:
{
"data": {
"type": "webhook",
"id": "15",
"attributes": {
"createdAt": "2021-04-28T09:35:01.028Z",
"label": "some label",
"url": "https://webhook.site/81ee6b53-fde4-4b7d-85a0-0b6249a4488d",
"status": "Enabled",
"contentType": "Json",
"deliveryMode": "AtLeastOnce",
"token": "MyToken",
"subscriptionType": "OnlyAuthorizationRequest"
}
}
}
White-Label Application Form
White-Label Application Form is a JSON:API resource, top-level fields:
id
string
Identifier of the white-label application form resource.
type
string
Type of the application form resource. The value is always
applicationFormV2.attributes
JSON Object
JSON object representing the white-label application form data.
links
object
Related Link object with url to be used in component.
relationships
JSON:API Relationships
Describes relationships between the white-label application form resource and other resources
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
updatedAt
RFC3339 Date string
The date the resource was updated.
tags
object
See Tags. Tags that will be copied to the application that this form creates (see Tag Inheritance).
applicationFormToken
object
The token that will be used to authenticate the applicant when they access the application form. This is used for embedding the form. See docs.
applicationFormSettings
object
The settings that will be used on the form. customize the application form. These are the org settings combined with legal links from Org Settings -> Application Form.
settingsOverride
Disclosure URLs that will override the ones that were defined in the application form settings.
url
string
The URL of the application form for the end-customer to access
Relationships
application
Optional, JSON:API Relationship
The Application resource that the application form has created. This relationship is only available if the application form has been completed by an end-customer and an application has been submitted.
Example White-Label Application Form resource:
{
"data": {
"type": "applicationFormV2",
"id": "15140",
"attributes": {
"createdAt": "2024-08-07T08:20:21.591Z",
"updatedAt": "2024-08-07T08:20:21.591Z",
"tags": {},
"applicationFormToken": {
"token": "ZXlKaGJHY2lPaUpTVXpJMU5pSXNJblI1Y0NJNklrcFhWQ0o5LmV5SnlaWE52ZFhKalpVbGtJam9pTVRVeE5EQWlMQ0owZVhCbElqb2lZWEJ3YkdsallYUnBiMjVHYjNKdElpd2laWGh3SWpveE56SXpNVEExTWpJeExDSmhZM1JwYjI0aU9uc2laR0YwWVVOdmJHeGxZM1JwYjI0aU9udDlmWDAuYkQwUjZiVnFJSHd0UC1PMFY0Ui03Vk1pa3haS05nLUQ5RlowOGcyQ25zcnJ6eXZxNzdKZEZWSUpZMWxaanlzRkJacWh1d3Y3T05TQU9udE52aHExTHhTYWJrYlZRTDVfX3J2aDJiZnN3RjZJejZmZGZCb29rY055UzdwZVNQVWZQWi1qalV6X2FZWEd4Zk1jeDhhWEVlV3JiNzVjUmV0T28xMGJsR3lhcmF6Z3N3UXgzSXdTN0gtR1pKRUdZTkR1SGZqdTNhZHB6RU5aR1BIN0s2MUJuUEszVEVKdmdHRlM4amhLQ0VoUkh4SkNmcENURUtGenhSNW5kZVNYanYtdWR3MFRVcndEcFdvUzI2X290ZkJfdkU5cVQwRTdjX2s0NjBkWEljWTdIN1M3QlBKUldqcDlNcFRGMGx3RDlxRXYzSVhZdFBDQk85TmxLcEVUMk5EdnRB",
"expiration": "2024-08-08T08:20:21.761Z"
},
"applicationFormSettings": {
"brandName": "Pied Piper",
"privacyPolicyUrl": "https://www.pipedpiper.com/gmail/",
"electronicDisclosuresUrl": "https://www.pipedpiper.com/gmail/",
"depositTermsUrl": "https://www.pipedpiper.com/gmail/",
"clientTermsUrl": "https://www.pipedpiper.com/gmail/",
"cardholderTermsUrl": "https://www.pipedpiper.com/gmail/",
"cashAdvancedTermsUrl": "https://www.pipedpiper.com/gmail/",
"contactUsEmail": "contact@pipedpiper.com"
}
},
"links": {
"related": {
"type": "text/html",
"href": "https://application-form.sh/view/ZXlKaGJHY2lPaUpTVXpJMU5pSXNJblI1Y0NJNklrcFhWQ0o5LmV5SnlaWE52ZFhKalpVbGtJam9pTVRVeE5EQWlMQ0owZVhCbElqb2lZWEJ3YkdsallYUnBiMjVHYjNKdElpd2laWGh3SWpveE56SXpNVEExTWpJeExDSmhZM1JwYjI0aU9uc2laR0YwWVVOdmJHeGxZM1JwYjI0aU9udDlmWDAuYkQwUjZiVnFJSHd0UC1PMFY0Ui03Vk1pa3haS05nLUQ5RlowOGcyQ25zcnJ6eXZxNzdKZEZWSUpZMWxaanlzRkJacWh1d3Y3T05TQU9udE52aHExTHhTYWJrYlZRTDVfX3J2aDJiZnN3RjZJejZmZGZCb29rY055UzdwZVNQVWZQWi1qalV6X2FZWEd4Zk1jeDhhWEVlV3JiNzVjUmV0T28xMGJsR3lhcmF6Z3N3UXgzSXdTN0gtR1pKRUdZTkR1SGZqdTNhZHB6RU5aR1BIN0s2MUJuUEszVEVKdmdHRlM4amhLQ0VoUkh4SkNmcENURUtGenhSNW5kZVNYanYtdWR3MFRVcndEcFdvUzI2X290ZkJfdkU5cVQwRTdjX2s0NjBkWEljWTdIN1M3QlBKUldqcDlNcFRGMGx3RDlxRXYzSVhZdFBDQk85TmxLcEVUMk5EdnRB"
}
}
}
}
Received ACH Debit Positive Pay
Received ACH Debit Positive Pay is a JSON:API resource, top-level fields:
id
string
Identifier of the Positive Pay rule.
type
string
Type of the resource. The value is always
receivedAchDebitPositivePay.attributes
JSON Object
JSON object representing the Positive Pay rule data.
relationships
JSON:API Relationships
Describes relationships between the Positive Pay rule and other resources.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
status
string
One of
Active, Expired, or Cancelled.originatorName
string
Name of the ACH debit originator.
originatorEntityId
string
Entity ID of the ACH debit originator.
amount
integer
Maximum allowed debit amount in cents.
expirationDateOptional
RFC3339 Date
Optional. When the authorization expires.
Relationships
Example Received ACH Debit Positive Pay resource:
{
"data": {
"type": "receivedAchDebitPositivePay",
"id": "1",
"attributes": {
"createdAt": "2026-01-15T10:00:00.000Z",
"status": "Active",
"originatorName": "Payroll Company Inc",
"originatorEntityId": "1234567",
"amount": 500000,
"expirationDate": "2026-12-31",
"tags": {
"purpose": "payroll"
}
},
"relationships": {
"account": {
"data": {
"type": "depositAccount",
"id": "123"
}
}
}
}
}
Received ACH Credit Positive Pay
Received ACH Credit Positive Pay is a JSON:API resource, top-level fields:
id
string
Identifier of the Positive Pay rule.
type
string
Type of the resource. The value is always
receivedAchCreditPositivePay.attributes
JSON Object
JSON object representing the Positive Pay rule data.
relationships
JSON:API Relationships
Describes relationships between the Positive Pay rule and other resources.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
status
string
One of
Active, Expired, or Cancelled.originatorName
string
Name of the ACH credit originator.
originatorEntityId
string
Entity ID of the ACH credit originator.
amount
integer
Maximum allowed credit amount in cents.
expirationDateOptional
RFC3339 Date
Optional. When the authorization expires.
Relationships
Example Received ACH Credit Positive Pay resource:
{
"data": {
"type": "receivedAchCreditPositivePay",
"id": "2",
"attributes": {
"createdAt": "2026-01-15T10:00:00.000Z",
"status": "Active",
"originatorName": "ACME Payouts",
"originatorEntityId": "9988776",
"amount": 1000000,
"expirationDate": "2026-12-31",
"tags": {
"purpose": "refund"
}
},
"relationships": {
"account": {
"data": {
"type": "depositAccount",
"id": "123"
}
}
}
}
}
Check Payment Positive Pay
Check Payment Positive Pay is a JSON:API resource, top-level fields:
id
string
Identifier of the Positive Pay rule.
type
string
Type of the resource. The value is always
checkPaymentPositivePay.attributes
JSON Object
JSON object representing the Positive Pay rule data.
relationships
JSON:API Relationships
Describes relationships between the Positive Pay rule and other resources.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
status
string
One of
Active, Expired, or Cancelled.checkNumber
string
Check number to authorize.
payeeNameOptional
string
Optional. Payee name to add specificity.
amount
integer
Expected amount in cents.
expirationDateOptional
RFC3339 Date
Optional. When the authorization expires.
Relationships
Example Check Payment Positive Pay resource:
{
"data": {
"type": "checkPaymentPositivePay",
"id": "3",
"attributes": {
"createdAt": "2026-01-15T10:00:00.000Z",
"status": "Active",
"checkNumber": "10045",
"payeeName": "ACME Corp",
"amount": 250000,
"expirationDate": "2026-12-31",
"tags": {
"category": "vendor"
}
},
"relationships": {
"account": {
"data": {
"type": "depositAccount",
"id": "123"
}
}
}
}
}
Wire Drawdown Positive Pay
Drawdown Positive Pay is a JSON:API resource, top-level fields:
id
string
Identifier of the Positive Pay rule.
type
string
Type of the resource. The value is always
drawdownPositivePay.attributes
JSON Object
JSON object representing the Positive Pay rule data.
relationships
JSON:API Relationships
Describes relationships between the Positive Pay rule and other resources.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
status
string
One of
AwaitingDocuments, Active, Expired, or Cancelled.expirationDateOptional
RFC3339 Date
Optional. When the authorization expires.
Relationships
Example Drawdown Positive Pay resource:
{
"data": {
"type": "drawdownPositivePay",
"id": "4",
"attributes": {
"createdAt": "2026-01-15T10:00:00.000Z",
"status": "AwaitingDocuments",
"expirationDate": "2026-12-31",
"tags": {
"purpose": "vendor-payment"
}
},
"relationships": {
"account": {
"data": {
"type": "depositAccount",
"id": "123"
}
}
}
}
}
Wire Drawdown
WireDrawdown is a JSON:API resource, top-level fields:
id
string
Identifier of the wire drawdown resource.
type
string
Type of the resource, the value is always
wire-drawdown.attributes
JSON Object
JSON object representing the wire drawdown data.
relationships
JSON:API Relationships
Describes relationships between the wire-drawdown resource and other resources.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
amount
integer
The amount (cents) of the wire drawdown.
description
string
Wire drawdown description.
direction
string
The direction of the wire drawdown, either
Incoming or Outgoing.imad
string
Input Message Accountability Data. It's a unique number given to each wire drawdown.
omad
string
Output Message Accountability Data. It's a unique number given to each wire drawdown.
senderReference
string
Sender reference.
referenceForBeneficiary
string
Reference for the Beneficiary.
beneficiaryInformation
string
Beneficiary Information, multi-line string delimited by
\n.beneficiaryAdviceInformation
string
Beneficiary Advice Information, multi-line string delimited by
\n.originatorToBeneficiaryInformation
string
Originator To Beneficiary Information, multi-line string delimited by
\n.Relationships
drawdownPayment
JSON:API Relationship
The Wire Payment created as a result of sending the drawdown payment.
Example WireDrawdown Resource:
{
"type": "wireDrawdown",
"id": "10000",
"attributes": {
"createdAt": "2024-10-29T21:35:58.898Z",
"amount": 97,
"direction": "Incoming",
"counterparty": {
"name": "LAB LLC",
"routingNumber": "021000021",
"accountNumber": "1000000000"
},
"imad": "20241029MMAAAAAA033351",
"omad": "20241029MMBBBBBB00041910291735FT03",
"description": "Hello World",
"senderReference": "54465316546"
},
"relationships": {
"account": {
"data": {
"type": "account",
"id": "10000"
}
},
"customer": {
"data": {
"type": "customer",
"id": "10000"
}
}
}
}
Wire Payment
WirePayment is a JSON:API resource, top-level fields:
id
string
Identifier of the wire payment resource.
type
string
Type of the payment resource. The value is always
wirePayment.attributes
JSON Object
JSON object representing the payment resource.
relationships
JSON:API Relationships
Describes relationships between the Wire payment and the originating deposit account, customer and transaction.
Attributes
createdAt
RFC3339 Date string
The date the resource was created.
status
string
Either
Pending, Returned, Sent , Canceled or Rejected (see reason for details).reasonOptional
string
Optional. More information about the status.
direction
string
The direction in which the funds flow (
Credit only).description
string
Payment description (maximum of 50 characters), this will show up on statement of the counterparty.
amount
string
The amount (cents) of the payment.
imadOmad
object
(Conditional) IMAD/OMAD - Input/Output Message Accountability Data. It's a unique number given to each FedWire payment in case of payment has been sent and fully processed.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to a multiple individual customers.
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"
}
}
}
}
}
Wire Transaction
WireTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
wireTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account and customer).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
imadOmad
object
(Conditional) IMAD/OMAD - Input/Output Message Accountability Data. It's a unique number given to each FedWire payment in case of payment has been sent and fully processed.
counterparty
The party on the other end of the transaction, either the beneficiary or the originator.
descriptionOptional
string
Optional. Description of the transaction as entered by the originator.
originatorToBeneficiaryInformation
string
Originator To Beneficiary Information, multi-line string delimited by
\n.senderReference
string
Sender reference.
referenceForBeneficiary
string
Reference for the Beneficiary.
beneficiaryInformation
string
Beneficiary Information, multi-line string delimited by
\n.beneficiaryAdviceInformation
string
Beneficiary Advice Information, multi-line string delimited by
\n.Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example 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",
"imadOmad": {
"imad": "123456",
"omad": "654321"
},
"counterparty": {
"name": "Jane Smith",
"routingNumber": "812345678",
"accountNumber": "10039",
"accountType": "Checking"
}
},
"relationships": {
"account": {
"data": {
"type": "depositAccount",
"id": "10035"
}
},
"customer": {
"data": {
"type": "customer",
"id": "5"
}
}
}
}
Write Off Transaction
writeOffTransaction is a JSON:API resource, top-level fields:
id
string
Identifier of the transaction resource.
type
string
Type of the transaction resource. The value is always
writeOffTransaction.attributes
JSON Object
JSON object representing the transaction data.
relationships
JSON:API Relationships
Describes relationships between the transaction resource and other resources (account, customer).
Attributes
createdAt
RFC3339 Date string
The date the transaction was created. Common to all transaction types.
direction
string
The direction in which the funds flow. Common to all transaction types.
amount
integer
The amount (cents) of the transaction. Common to all transaction types.
balance
integer
The account balance (cents) after the transaction. Common to all transaction types.
summary
string
Summary of the transaction. Common to all transaction types.
Relationships
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers
Optional, Array of JSON:API Relationship
The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
Example WriteOffTransaction resource:
{
"type": "writeOffTransaction",
"id": "98",
"attributes": {
"createdAt": "2023-08-15T14:23:45.385Z",
"amount": 3500,
"direction": "Credit",
"balance": 0,
"summary": "Write off for account 10014"
},
"relationships": {
"account": {
"data": {
"type": "account",
"id": "10014"
}
},
"customer": {
"data": {
"type": "customer",
"id": "10009"
}
},
"customers": {
"data": [
{
"type": "customer",
"id": "10009"
}
]
}
}
}