Resources

Account End-Of-Day

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

Name	Type	Description
id Required	string	Identifier of the account end-of-day resource.
type Required	string	Type of the account end-of-day resource. The value is always accountEndOfDay.
attributes Required	JSON Object	JSON object representing the account end-of-day data.
relationships Required	JSON:API Relationships	Describes relationships between the statement resource and other resources (account and customer).

Attributes

Name	Type	Description
date Required	ISO Local Date string	The date the account end-of-day resource was created.
balance Required	integer	The balance amount (in cents). The balance equals thee sum of 'available' and 'hold'.
hold Required	integer	The hold amount (in cents). Not available for spending.
available Required	integer	The available balance for spending (in cents).
overdraftLimit Optional	integer	The overdraft limit amount.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The account the resource belongs to.
customer Required	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 Required	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:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always accountLowBalanceClosureTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (accounts, customer).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
receiverCounterparty Required	Counterparty	The receiving party of the transaction.
tags Required	object	See Tags. Inherited from the payment tags (see Tag Inheritance).

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
receiverAccount Required	JSON:API Relationship	The Deposit Account receiver.

Example AccountLowBalanceClosureTransaction resource:

{
  "data": {
    "type": "accountLowBalanceClosureTransaction",
    "id": "53",
    "attributes": {
      "createdAt": "2022-04-06T10:46:34.371Z",
      "receiverCounterparty": {
        "name": "Unit Finance Inc.",
        "routingNumber": "091311229",
        "accountNumber": "864800000000",
        "accountType": "Checking"
      },
      "amount": 800,
      "direction": "Credit",
      "balance": 113000,
      "summary": "Account Low Balance Closure",
      "tags": {
        "customer_type": "vip"
      }
    },
    "relationships": {
      "account": {
        "data": {
          "type": "account",
          "id": "10001"
        }
      },
      "customer": {
        "data": {
          "type": "customer",
          "id": "10000"
        }
      },
      "customers": {
        "data": [
          {
            "type": "customer",
            "id": "10000"
          }
        ]
      },
      "org": {
        "data": {
          "type": "org",
          "id": "1"
        }
      },
      "receiverAccount": {
        "data": {
          "type": "account",
          "id": "10000"
        }
      }
    }
  }
}

AccountHold

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

Name	Type	Description
id Required	string	Identifier of the account hold resource.
type Required	string	Type of the resource, the value is always accountHold.
attributes Required	JSON Object	JSON object representing the account hold data.
relationships Required	JSON:API Relationships	Describes relationships between the account hold resource and the account.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
status Required	string	Status of the account hold, either Active, Released, PartiallyReleased.
amount Required	integer	The amount (cents) of the payment.
remainingHoldAmount Optional	integer	The remaining amount (cents) being held. Only present when status is PartiallyReleased.
expiredAt Optional	RFC3339 Date string	Date only (e.g. "2001-08-15"). the date the account hold will be automatically released at.
description Required	string	Account hold description (maximum of 80 characters).
tags Optional	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Account the account hold belongs to.

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:

Name	Type	Description
id Required	string	Identifier of the ACH counterparty resource.
type Required	string	Type of the ACH counterparty resource.
attributes Required	JSON Object	JSON object representing the counterparty resource.
relationships Required	JSON:API Relationships	Describes relationships between the ACH counterparty and the originating customer.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
name Required	string	The account holder's name (whether an individual or a business).
routingNumber Required	string	Valid 9-digit ABA routing transit number.
bank Required	string	Name of the bank.
accountNumber Required	string	Bank account number.
accountType Required	string	Either Checking, Savings or Loan.
type Required	string	Either Business, Person or Unknown.
permissions Required	string	Either CreditOnly or CreditAndDebit.
tags Required	object	See Tags.

Relationships

Name	Type	Description
customer Required	JSON:API Relationship	The customer the counterparty belongs to.

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:

Name	Type	Description
id Required	string	Identifier of the ACH payment resource.
type Required	string	Type of the payment resource. For originations the value is achPayment.
attributes Required	JSON Object	JSON object representing the payment resource.
relationships Required	JSON:API Relationships	Describes relationships between the ACH payment and the originating deposit account and customer.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
status Required	string	One of Pending,Pending Review, Rejected, Clearing, Sent, Canceled, Returned. See ACH Status.
reason Optional	string	More information about the status.
counterparty Required	Counterparty	The party on the other side of the ACH payment.
direction Required	string	The direction in which the funds flow (either Debit or Credit).
description Required	string	Payment description (maximum of 10 characters), also known as Company Entry Description, this will show up on statement of the counterparty.
addenda	string	Optional, additional payment description (maximum of 50 characters), not all institutions present that.
amount Required	integer	The amount (cents) of the payment.
settlementDate	RFC3339 Date string	Optional, for ACH debit with statuses Pending,Clearing, shows the date on which the payment will be settled.
expectedCompletionDate	RFC3339 Date string	Optional, for ACH credit with statuses Pending,Sent, shows the date on which the counterparty will handle the request.
tags Required	object	See Tags.
counterpartyVerificationMethod	string	Optional, shows the verification method of the counterparty : 'Plaid'.
sameDay Required	boolean	Indicates whether the payment is a Same Day ACH payment. See Same Day ACH.
secCode Required	string	The 3-letter ACH Standard Entry Class (SEC) Code. One of WEB, CCD, PPD.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account originating the transfer.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
counterparty Required	JSON:API Relationship	The Counterparty the payment to be made to.
transaction Optional	JSON:API Relationship	The transaction generated by this payment. Generated instantly in cases where a credit ach payment is converted to a book payment, otherwise, once the payment is sent.
recurringPayment Required	Optional, JSON:API Relationship	The recurring payment belonging to this payment.

Example AchPayment resource:

{
  "data": {
    "type": "achPayment",
    "id": "50",
    "attributes": {
      "createdAt": "2020-01-13T16:01:19.346Z",
      "status": "Pending",
      "counterparty": {
        "routingNumber": "812345678",
        "accountNumber": "12345569",
        "accountType": "Checking",
        "name": "Jane Doe"
      },
      "description": "Funding",
      "direction": "Credit",
      "amount": 10000,
      "sameDay": false,
      "secCode": "WEB"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "555"
        }
      },
      "customer": {
        "data": {
          "type": "individualCustomer",
          "id": "99823"
        }
      },
      "counterparty": {
        "data": {
          "type": "counterparty",
          "id": "4567"
        }
      },
      "transaction": {
        "data": {
          "type": "transaction",
          "id": "4003"
        }
      }
    }
  }
}

ACH Received Payment

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

Name	Type	Description
id Required	string	Identifier of the received payment resource.
type Required	string	Type of the transaction resource. The value is always achReceivedPayment.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account, customer related transactions).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all receive payment types.
status Required	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 Required	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 Required	boolean	Will be true if the received payment can be advanced.
direction Required	string	The direction in which the funds flow (either Debit or Credit).
completionDate Required	RFC3339 Date string	Shows the date on which the received ACH will be completed(settled or repaid).
returnReason Optional	string	The reason if the received payment is Returned. See ACH return reasons.
amount Required	integer	The amount (cents) of the ACH received payment. Common to all received payment types.
description Required	string	ACH description (maximum of 10 characters), also known as Company Entry Description.
addenda Optional	string	Additional transaction description (maximum of 80 characters).
companyName Required	string	The name by which the originator is known to the receiver.
originatorEntityId Optional	string	A unique identifier by which the originator is formally recognized within the ACH network.
receivingEntityName Optional	string	The name of the Recipient as it was declared by the originator of the payment.
counterpartyRoutingNumber Required	string	The routing number of the party that originated the received ACH payment.
traceNumber Required	string	The ACH Trace Number.
secCode Optional	string	The 3-letter ACH Standard Entry Class (SEC) Code (e.g. WEB, CCD, PPD, etc.).
returnCutoffTime Optional	RFC3339 Date string	The last time when a reprocess will be accepted. Will be the next banking day 2pm ET.
canBeReprocessed Optional	boolean	If set to true, the Received Payment can be reprocessed until the returnCutoffTime. If empty, the Received Payments can't be reprocessed.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	Optional, JSON:API Relationship	The Customer the deposit account belongs to, business or individual.
receivePaymentTransaction Required	Optional, JSON:API Relationship	The transaction of the received payment, created due to advance or when the ACH is processed.
paymentAdvanceTransaction Required	Optional, JSON:API Relationship	The transaction that funded the Advance from the provisional credit operating account, if the received payment was advanced.
repayPaymentAdvanceTransaction Required	Optional, JSON:API Relationship	The transaction that repaid the advance once the received payment is completed.
stopPayment Optional	JSON:API Relationship	Available for payments that were stopped.

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:

Name	Type	Description
id Required	string	Identifier of the received payment resource.
type Required	string	Type of the transaction resource. The value is always wireReceivedPayment.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account, customer related transactions).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all receive payment types.
status Required	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 Required	string	The direction in which the funds flow (Credit only).
returnReason Optional	string	The reason if the received payment is Returned.
amount Required	integer	The amount (cents) of the wire received payment. Common to all received payment types.
description Required	string	Payment description (maximum of 50 characters).
counterparty Required	Counterparty	The party on the other end of the transaction, either the beneficiary or the originator.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	Optional, JSON:API Relationship	The Customer the deposit account belongs to, business or individual.
receivePaymentTransaction Required	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:

Name	Type	Description
id Required	string	Identifier of the declined incoming payment resource.
type Required	string	Type of the declined incoming payment resource. The value is always declinedIncomingPayment.
attributes Required	JSON Object	JSON object representing the declined incoming payment resource.
relationships Required	JSON:API Relationships	Describes relationships between the declined incoming payment and the originating deposit account and customer.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
reason Required	string	The reason for the transaction return. See ACH return reasons.
direction Required	string	The direction in which the funds flow (either Debit or Credit).
amount Required	integer	The amount (cents) of the payment.
type Required	string	Type of the payment resource.

Currently only AchPayment payment type is supported.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account originating the transfer.
customer Required	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:

Name	Type	Description
id Required	string	Identifier of the ACH repayment resource.
type Required	string	Type of the payment resource. For ach repayment the value is achRepayment.
attributes Required	JSON Object	JSON object representing the repayment resource.
relationships Required	JSON:API Relationships	Describes relationships between the ACH repayment and the originating deposit account, credit account and org.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Required	RFC3339 Date string	The date the resource was updated.
amount Required	integer	The amount (cents) of the payment.
status Required	string	Either Pending, PendingReview, Returned, Sent or Rejected
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account originating the repayment.
creditAccount Required	JSON:API Relationship	The Credit Account the repayment is made for.
org Required	JSON:API Relationship	The org the customer belongs to.
customer Required	Optional, JSON:API Relationship	The Customer the credit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
counterparty Required	JSON:API Relationship	The Counterparty the repayment to be made from.
payment Required	JSON:API Relationship	The payment created between the account and the counterparty
recurringRepayment Required	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:

Name	Type	Description
id Required	string	Identifier of the ACH stop payment resource.
type Required	string	Type of the ACH stop payment resource. The value is always achStopPayment.
attributes Required	JSON Object	JSON object representing the ACH stop payment resource.
relationships Required	JSON:API Relationships	Describes relationships between the ACH stop payment resource and other resources

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Required	RFC3339 Date string	The date the resource was updated.
minAmount Optional	integer	The amount (cents) above which a received ACH payments will be stopped.
originatorName Optional	Array of strings	Array of originator names to look on a payment to stop.
direction Required	string	Debit only.
expiration Required	RFC3339 Date string	Expiration date fo the stop payment
isMultiUse Required	Boolean
description Required	String
disableReason Optional	string	One of Expired, Requested or PaymentStopped
idempotencyKey	string	Optional, but strongly recommended . See Idempotency.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account receiving the check payment and will be debited for it.
customer Required	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 Required	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:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always adjustmentTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
description Required	string	Description of the transaction.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account participating in the transaction.

Example AdjustmentTransaction resource:

{
  "type": "adjustmentTransaction",
  "id": "215",
  "attributes": {
    "createdAt": "2021-04-12T16:08:39.040Z",
    "amount": 5000,
    "direction": "Debit",
    "balance": 3124000,
    "summary": "correction of transaction #200",
    "description": "correction of transaction #200"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "10001"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "10000"
      }
    }
  }
}

APIToken

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

Name	Type	Description
id Required	string	Identifier of the api token resource.
type Required	string	Type of the api token resource. The value is always apiToken.
attributes Required	JSON Object	JSON object representing the api token data.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the API token was created.
description Required	string	A description of the API token.
expiration Required	RFC3339 Date string	Expiration date of the API token.
token Optional	string	The actual bearer token. Available only on API token creation response.
sourceIp Optional	string	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:

Name	Type	Description
id Required	string	Identifier of the document resource.
type Required	string	Always document.
attributes Required	JSON Object	JSON object representing the document's data.

Attributes

Name	Type	Description
status	string	One of Required, ReceivedBack, ReceivedFront, Invalid, Approved or PendingReview, see Application Document Status.
documentType Required	string	One of IdDocument, Passport, AddressVerification, CertificateOfIncorporation, EmployerIdentificationNumberConfirmation, SocialSecurityCard, ClientRequested or SelfieVerification.
description Required	string	The document requirements description.
name Required	string	Name of business or individual.
address Required	Address	Individual address, present only for the AddressVerification document type.
dateOfBirth Required	RFC3339 Date string	Date only (e.g. "2001-08-15"). Present only for Passport and IdDocument document types.
passport Required	string	Individual passport number. Present only for the Passport document type.
ein Required	string	Business EIN. Present only for the EmployerIdentificationNumberConfirmation document type.
reasonCode Required	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 Required	string	Application Document rejection reason. Present only when document status is Invalid.
archived Required	boolean	When true , uploading a document is disabled.
evaluationFlags Required	Array of EvaluationFlag	A list of evaluation flags providing additional context for the document status.

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",
    "evaluationFlags": [
      {
        "description": "The document was processed by Serial Fraud Monitor"
      },
      {
        "messageCode": "120P",
        "description": "Quality of the document image is low"
      },
      {
        "description": "The authentication tests passed"
      }
    ]
  }
}

Approved Credit Application

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

Name	Type	Description
id Required	string	Identifier of the application resource.
type Required	string	Type of the credit application resource. For existingCustomerCreditApplication the value is always existingCustomerCreditApplication.
attributes Required	JSON Object	JSON object representing the credit application data.
relationships Required	JSON:API Relationships	Describes relationships between the credit application resource and other resources.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
status Required	string	The status of the credit application. will be always Approved.
aggregatorAccessTokens Optional	Array of string	Array of aggregator access tokens which are Plaid (or other account linking platform) integration tokens. See Plaid processor token
annualIncome Optional	Integer (Cents)	The annual income of the applicant.
numberOfEmployees Optional	NumberOfEmployees	Number of employees of the business.
yearsInBusiness Optional	Integer	Number of years the business has been in operation.
additionalUnderwritingData Optional	json	Object containing key-value pairs of underwriting data per credit policy.

Relationships

Name	Type	Description
application Required	JSON:API Relationship	The Application to which this credit application applies to.
lendingProgram Required	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:

Name	Type	Description
id Required	string	Identifier of the authorization request resource.
type Required	string	Type of the authorization request resource. The value is always atmAuthorizationRequest.
attributes Required	JSON Object	JSON object representing the authorization request data.
relationships Required	JSON:API Relationships	Describes relationships between the authorization request resource and other resources (account, customer and card).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the authorization request was created.
amount Required	integer	The amount (cents) of the authorization request.
status Required	string	The status of the authorization request. Either Pending, Approved or Declined.
partialApprovalAllowed Required	boolean	Indicates whether the authorization request supports partial amount approval.
approvedAmount Optional	integer	The amount (cents) that was approved. Available only when status is Approved.
declineReason Optional	string	The reason the authorization request was declined. One of AccountClosed, CardExceedsAmountLimit, DoNotHonor, InsufficientFunds, InvalidMerchant, ReferToCardIssuer, RestrictedCard, Timeout, TransactionNotPermittedToCardholder. Available only when status is Declined
direction Required	string	The direction in which the funds flow (either Debit or Credit).
atmName Required	string	The name of the ATM.
atmLocation Optional	string	The location (city, state, etc.) of the ATM.
surcharge Required	number	The surcharge fee (cents) for the transaction.
internationalServiceFee Optional	number	The fee (cents) for international transactions.
cardNetwork Optional	string	The card network used, one of: Visa, Interlink, Accel, Allpoint, Other.
tags Required	object	See Tags.
currencyConversion Optional	Currency Conversion	When original currency for transaction is not USD.
isInternational Optional	boolean	Indicates whether the transaction is international.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
card Required	JSON:API Relationship	The debit card used in the purchase.

Example AtmAuthorizationRequest resource:

{
  "type": "atmAuthorizationRequest",
  "id": "1",
  "attributes": {
    "createdAt": "2021-06-22T13:39:17.018Z",
    "amount": 2500,
    "status": "Pending",
    "partialApprovalAllowed": false,
    "direction": "Debit",
    "atmName": "HOME FED SAV BK",
    "atmLocation": "Cupertino, CA, US",
    "surcharge": 0,
    "internationalServiceFee": 0,
    "cardNetwork": "Allpoint",
    "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:

Name	Type	Description
type Required	string	Type of the authorization request resource. The value is always pendingAuthorizationRequest.
id Required	string	The authorization request id
attributes Required	JSON Object	JSON object representing the authorization request data.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
available Required	integer	The available balance for spending (in cents).
status Required	string	The status of the request. will be always "Pending"
partialApprovalAllowed Required	boolean	Indicates whether the authorization request supports partial amount approval.
direction Required	string	The direction in which the funds flow (either Debit or Credit).
atmName Required	string	The name of the ATM.
atmLocation Optional	string	The location (city, state, etc.) of the ATM.
surcharge Required	number	The surcharge fee (cents) for the transaction.
internationalServiceFee Optional	number	The fee (cents) for international transactions.
mustBeApproved Required	boolean	Indicates whether the authorization request must be approved.
idempotencyKey Required	string	See Idempotency
tags Required	object	See Tags.
currencyConversion Optional	Currency Conversion	When original currency for transaction is not USD.
isInternational Optional	boolean	Indicates whether the transaction is international.
cardNetwork Optional	string	The network that this card is a part of, e.g. Visa, Interlink, etc.

Name	Type	Description
account Required	JSON:API Relationship	The account of the customer creating the atm transaction.
customer Required	JSON:API Relationship	The customer that created the atm transaction.
card Required	JSON:API Relationship	The debit card used in the transaction.
authorizationRequest Required	JSON:API Relationship	The authorization request.

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:

Name	Type	Description
type Required	string	Type of the ATM location resource. The value is always atmLocation.
attributes Required	JSON Object	JSON object representing the ATM location data.

Attributes

Name	Type	Description
network Required	string	Name of the ATM network.
locationName Required	string	Name of the ATM's location.
coordinates Required	Coordinates	Coordinates (latitude, longitude) of the ATM.
address Required	Address	Address of the ATM.
distance Required	number	Distance to the ATM (in miles).
surchargeFree Required	boolean	Indicates if the ATM is surcharge free.
acceptDeposits Required	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:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always atmTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account and customer).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction, including the surcharge fee. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
cardLast4Digits Required	string	The last 4 digits of the debit card involved in the transaction.
atmName Required	string	The name of the ATM.
atmLocation Optional	string	The location (city, state, etc.) of the ATM.
surcharge Required	number	The surcharge fee (cents) for the transaction.
interchange Optional	string	The interchange share for this transaction. Calculated at the end of each day, see the transaction.updated event.
grossInterchange Optional	string	The gross interchange share for this transaction.
cardNetwork Optional	string	The card network used, one of: Visa, Interlink, Accel, Allpoint, Other.
tags Required	object	See Tags.
currencyConversion Optional	Currency Conversion	When original currency for transaction is not USD.
cardDecisionSource Optional	string	Who made the final card authorization decision. See Understanding authorization decisions. One of Org, Unit, Network, TimeoutApprove, TimeoutDecline, DefaultApprove, InternalError, IssuerStandIn.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
card Required	JSON:API Relationship	The debit card involved in the transaction.

Example AtmTransaction resource:

{
  "type": "atmTransaction",
  "id": "1432",
  "attributes": {
    "createdAt": "2020-07-05T15:49:36.864Z",
    "direction": "Credit",
    "amount": 10000,
    "balance": 12000,
    "summary": "ATM deposit",
    "cardLast4Digits": "2282",
    "atmName": "First National Bank",
    "atmLocation": "Masontown, PA 15461",
    "surcharge": 10,
    "cardNetwork": "Allpoint",
    "grossInterchange": "200.00",
    "cardDecisionSource": "Org"
  },
  "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:

Name	Type	Description
id Required	string	Identifier of the authorization resource.
type Required	string	Type of the authorization resource. The value is always authorization.
attributes Required	JSON Object	JSON object representing the authorization data.
relationships Required	JSON:API Relationships	Describes relationships between the authorization resource and other resources (account and customer).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the authorization was created.
amount Required	integer	The amount (cents) of the authorization.
cardLast4Digits Required	string	The last 4 digits of the debit card involved in the authorization.
status Required	string	One of Authorized, Completed, Canceled, Declined, see Authorization Statuses.
cardDecisionSource Optional	string	Who made the final card authorization decision. See Understanding authorization decisions. One of Org, Unit, Network, TimeoutApprove, TimeoutDecline, DefaultApprove, InternalError, IssuerStandIn.
declineReason Optional	string	The reason the authorization was declined. Available only when status is Declined
declineDescription Optional	string	A human-readable description providing additional detail about the decline. Only present on some declined authorizations.
declinedBy Optional	string	The entity that declined the authorization. One of Visa, Org, or Unit. Available only when status is Declined.
merchant.name Required	string	The name of the merchant.
merchant.type Required	integer	The 4-digit ISO 18245 merchant category code (MCC).
merchant.category Required	string	The merchant category, described by the MCC code (see this reference for the list of category descriptions).
merchant.location Optional	string	The location (city, state, etc.) of the merchant.
merchant.id Optional	string	The unique network merchant identifier.
recurring Required	boolean	Indicates whether the authorization is recurring
paymentMethod Optional	string	The payment method used, one of: Manual, Swipe, Contactless, ChipAndPin, Stored, Other.
digitalWallet Optional	string	The type of digital wallet used, one of: Google, Apple, Other.
cardVerificationData.verificationMethod Optional	string	The verification method used, one of: Address, CVV2, AddressAndCVV2.
cardNetwork Optional	string	The card network used, one of: Visa, Interlink, Accel, Allpoint, Other.
tags Required	object	See Tags. Inherited from the authorization request tags (see Tag Inheritance).
cashWithdrawalAmount Optional	integer	Cash withdrawal amount
summary Optional	string	Summary of the authorization.
richMerchantData Optional	Rich Merchant Data	Full merchant information.
currencyConversion Optional	Currency Conversion	When original currency for transaction is not USD

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	JSON:API Relationship	The debit card involved in the authorization.
customers Required	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 Required	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",
    "cardDecisionSource": "Org",
    "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 ",
    "declineReason": "DoNotHonor",
    "declineDescription": "Card not effective (not activated)",
    "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:

Name	Type	Description
id Required	string	Identifier of the authorization card fraud case resource.
type Required	string	Type of the authorization card fraud case resource. The value is always authorizationCardFraudCase
attributes Required	JSON Object	JSON object representing the authorization card fraud case data.
relationships Required	JSON:API Relationships	Describes relationships between the authorization card fraud case resource and other resources.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
status Required	string	The status of the card fraud case. Can be one of Created, Active, Closed, Expired.
decision Required	string	The decision made for the card fraud case. Can be one of Pending, Fraud, NoFraud.
expiresAt Required	RFC3339 Date string	The date the card fraud case expires.
cardActivities Required	Array of Fraud Case Card Activity	The card activities associated with the card fraud case.
updatedAt Optional	RFC3339 Date string	The date the resource was last updated.

Relationships

Name	Type	Description
card Required	JSON:API Relationship	The Card the fraud case is related to.
account Required	JSON:API Relationship	The Account the card belongs to.
customer Required	JSON:API Relationship	The individual or business Customer the card belongs to.
transaction Required	JSON:API Relationship	The primary Authorization card activity of the card fraud case.

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:

Name	Type	Description
id Required	string	Identifier of the batch-release resource.
type Required	string	Type of the batch-release resource. The value is always batchRelease.
attributes Required	JSON Object	JSON object representing the batch-release data.
relationships Required	JSON:API Relationships	Describes relationships between the batch-release resource and other resources (accounts).

Attributes

Name	Type	Description
amount Required	integer	The amount (in cents) to move from the batch account to the receiver account.
description Required	string	Description of the payment.
senderName Required	string	Name of the sender, before combining the payments.
senderAddress Required	Address	Address of the sender.
senderAccountNumber Required	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

Name	Type	Description
batchAccount Required	JSON:API Relationship	The batch account to release the funds from.
receiver Required	JSON:API Relationship	The account to release the funds to.

Example BatchRelease resource:

{
  "type": "batchRelease",
  "id": "100123",
  "attributes": {
    "amount": 3000,
    "description": "Gift",
    "senderName": "Sherlock Holmes",
    "senderAccountNumber": "4581133972",
    "senderAddress": {
      "street": "221B Baker Street",
      "city": "London",
      "postalCode": "NW1 6XE",
      "country": "UK"
    }
  },
  "relationships": {
    "batchAccount": {
      "data": {
        "type": "batchAccount",
        "id": "10104"
      }
    },
    "receiver": {
      "data": {
        "type": "depositAccount",
        "id": "10097"
      }
    }
  }
}

BeneficialOwner

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

Name	Type	Description
id Required	string	Identifier of the beneficial owner resource.
type Required	string	Always beneficialOwner.
attributes Required	JSON Object	JSON object representing the beneficial owner's data.

Attributes

Name	Type	Description
status Required	string	One of Approved, Denied or PendingReview.
fullName Required	FullName	Full name of the beneficial owner.
ssn	string	SSN (or ITIN) of the beneficial owner (numbers only). Either an ssn or passport is required.
passport	string	Passport number of the beneficial owner. Valid only for non-US persons. Either an ssn or passport number is required.
nationality	ISO31661-Alpha2 string	Required if a passport is used as the main ID and optional when ssn is used. Two letters representing the beneficial owner's nationality. (e.g. "US").
dateOfBirth Required	RFC3339 Date string	Date only (e.g. "2001-08-15").
address Required	Address	The beneficial owner's address.
phone Required	Phone	The beneficial owner's phone number.
email Required	string	The beneficial owner's email address.
percentage Required	integer	Beneficial ownership percentage in the business (between 25 and 100).
occupation Optional	Occupation	Occupation of the beneficial owner.
annualIncome Optional	AnnualIncome	Annual income of the beneficial owner.
sourceOfIncome Optional	SourceOfIncome	Source of income of the beneficial owner.

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",
    "percentage": 25,
    "occupation": "ArchitectOrEngineer",
    "annualIncome": "Between50kAnd100k",
    "sourceOfIncome": "EmploymentOrPayrollIncome"
  }
}

Officer

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

Name	Type	Description
id Required	string	Identifier of the officer resource.
type Required	string	Always officer.
attributes Required	JSON Object	JSON object representing the officer's data.
relationships Required	JSON:API Relationships	Describes relationships between the officer and other resources (org and customer).

Attributes

Name	Type	Description
status Required	string	One of Approved, Denied or PendingReview.
fullName Required	FullName	Full name of the officer.
title Required	OfficerTitle	Title of the officer.
ssn	string	SSN (or ITIN) of the officer (numbers only). Either an ssn or passport is required.
passport	string	Passport number of the officer. Valid only for non-US persons. Either an ssn or passport number is required.
nationality	ISO31661-Alpha2 string	Required if a passport is used as the main ID and optional when ssn is used. Two letters representing the officer's nationality. (e.g. "US").
dateOfBirth Required	RFC3339 Date string	Date only (e.g. "2001-08-15").
address Required	Address	The officer's address.
phone Required	Phone	The officer's phone number.
email Required	string	The officer's email address.
occupation Optional	Occupation	Occupation of the officer.
annualIncome Optional	AnnualIncome	Annual income of the officer.
sourceOfIncome Optional	SourceOfIncome	Source of income of the officer.

Relationships

Name	Type	Description
org Required	JSON:API Relationship	The Org this officer belongs to.
customer Required	JSON:API Relationship	The business Customer this officer belongs to.

Example Officer resource:

{
  "type": "officer",
  "id": "12",
  "attributes": {
    "status": "Approved",
    "fullName": {
      "first": "Richard",
      "last": "Hendricks"
    },
    "title": "CEO",
    "ssn": "721074426",
    "dateOfBirth": "1980-09-10",
    "address": {
      "street": "5230 Newell Rd",
      "street2": null,
      "city": "Palo Alto",
      "state": "CA",
      "postalCode": "94303",
      "country": "US"
    },
    "phone": {
      "countryCode": "1",
      "number": "5555555555"
    },
    "email": "richard@piedpiper.com",
    "occupation": "ExecutiveOrManager",
    "annualIncome": "Between100kAnd250k",
    "sourceOfIncome": "EmploymentOrPayrollIncome"
  },
  "relationships": {
    "org": {
      "data": {
        "type": "org",
        "id": "1"
      }
    },
    "customer": {
      "data": {
        "type": "businessCustomer",
        "id": "1"
      }
    }
  }
}

Book Payment

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

Name	Type	Description
id Required	string	Identifier of the book payment resource.
type Required	string	Type of the payment resource. The value is always bookPayment.
attributes Required	JSON Object	JSON object representing the payment resource.
relationships Required	JSON:API Relationships	Describes relationships between the Book payment and the originating deposit account and customer.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
status Required	string	Either Sent or Rejected (see reason for details).
reason Optional	string	More information about the status.
direction Required	string	The direction in which the funds flow (either Debit or Credit).
description Required	string	Payment description (maximum of 80 characters), this will show up on statement of the counterparty.
transactionSummaryOverride Required	string	If this field is populated, its contents will be returned as the bookTransaction's summary field (maximum of 100 characters).
amount Required	string	The amount (cents) of the payment.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account creating the payment.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to a multiple individual customers.
counterpartyAccount Required	JSON:API Relationship	The Counterparty account the payment to be made to.
counterpartyCustomer Required	JSON:API Relationship	The Customer the counterparty account belongs to. The customer is either a business or an individual, might be empty if there is more than one associated customer.
transaction Required	JSON:API Relationship	The Book Transaction generated by this payment.
recurringPayment Required	Optional, JSON:API Relationship	The recurring payment belonging to this payment.

Example BookPayment resource:

{
  "data": {
    "type": "bookPayment",
    "id": "1232",
    "attributes": {
      "createdAt": "2021-02-21T13:03:19.025Z",
      "amount": 1500,
      "direction": "Credit",
      "description": "Funding",
      "status": "Sent"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "account",
          "id": "555"
        }
      },
      "customer": {
        "data": {
          "type": "customer",
          "id": "10000"
        }
      },
      "counterpartyAccount": {
        "data": {
          "type": "account",
          "id": "99821"
        }
      },
      "counterpartyCustomer": {
        "data": {
          "type": "customer",
          "id": "10000"
        }
      },
      "transaction": {
        "data": {
          "type": "transaction",
          "id": "1413"
        }
      }
    }
  }
}

Book Repayment

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

Name	Type	Description
id Required	string	Identifier of the Book repayment resource.
type Required	string	Type of the payment resource. For book repayment the value is bookRepayment.
attributes Required	JSON Object	JSON object representing book repayment resource.
relationships Required	JSON:API Relationships	Describes relationships between the book repayment and the originating deposit account, credit account and org.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Required	RFC3339 Date string	The date the resource was updated.
amount Required	integer	The amount (cents) of the payment.
status Required	string	Either Sent or Rejected
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account originating the repayment.
creditAccount Required	JSON:API Relationship	The Credit Account the repayment is made for.
org Required	JSON:API Relationship	The org the customer belongs to.
customer Required	Optional, JSON:API Relationship	The Customer the credit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
counterpartyAccount Required	JSON:API Relationship	The Deposit Account the repayment to be made from.
payment Required	JSON:API Relationship	The payment created between the account and counterpartyAccount
recurringRepayment Required	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:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always bookTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account and customer).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
counterparty Required	Counterparty	The party on the other end of the transaction.
tags Required	object	See Tags. Inherited from the payment tags (see Tag Inheritance).

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
counterpartyAccount Required	JSON:API Relationship	The account of the counterparty.
counterpartyCustomer Required	JSON:API Relationship	The counterparty customer.
payment Required	Optional, JSON:API Relationship	The payment belonging to this transaction.
recurringPayment Required	Optional, JSON:API Relationship	The recurring payment belonging to this transaction.

Example BookTransaction resource:

{
  "type": "bookTransaction",
  "id": "9547",
  "attributes": {
    "createdAt": "2020-07-05T15:49:36.864Z",
    "direction": "Credit",
    "amount": 1000,
    "balance": 12000,
    "summary": "Counterparty: Jane Smith | Description: Gift",
    "counterparty": {
      "name": "Jane Smith",
      "routingNumber": "812345678",
      "accountNumber": "10039",
      "accountType": "Checking"
    }
  },
  "relationships": {
    "account": {
      "data": {
        "type": "depositAccount",
        "id": "10035"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "5"
      }
    },
    "counterpartyAccount": {
      "data": {
        "type": "account",
        "id": "10036"
      }
    },
    "counterpartyCustomer": {
      "data": {
        "type": "customer",
        "id": "7"
      }
    },
    "payment": {
      "data": {
        "type": "payment",
        "id": "10000"
      }
    }
  }
}

BusinessApplication

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

Name	Type	Description
id Required	string	Identifier of the application resource.
type Required	string	Type of the application resource, for business application the value is always businessApplication.
attributes Required	JSON Object	JSON object representing the application data.
relationships Required	JSON:API Relationships	Describes relationships between the application resource and other resources (documents).

Attributes

Name	Type	Description
status Required	string	One of AwaitingDocuments, PendingReview, Approved, Denied or Pending, see Application Statuses.
message Required	string	A message describing the BusinessApplication status.
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Optional	RFC3339 Date string	The date the resource was updated.
name Required	string	Name of the business.
dba Optional	string	"Doing business as".
address Required	Address	Address of the business.
operatingAddress	Address	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.
phone Required	Phone	Phone of the business.
stateOfIncorporation Required	string	Two letters representing a US state.
ein Required	string	Business EIN (numbers only).
entityType Required	string	One of LLC, Partnership, PubliclyTradedCorporation, PrivatelyHeldCorporation or NotForProfitOrganization.
website Optional	string	Business's website.
contact Required	BusinessContact	Primary contact of the business.
officer Required	Officer	Officer representing the business. See OfficerTitle for allowed title values. To successfully onboard a business, provide the officer's personal details.
beneficialOwners Required	Array of BeneficialOwner	Array of beneficial owners in the business. A beneficial owner is anyone who owns at least 25% of the business. To successfully onboard a business, provide each beneficial owner's personal details. If the business has no beneficial owners, the array should be empty.
attestedNoBeneficialOwners Required	boolean	true if no beneficial owners are provided; otherwise - false .
annualRevenue Optional	AnnualRevenue	Annual revenue of the business.
numberOfEmployees Optional	NumberOfEmployees	Number of employees of the business.
cashFlow Optional	CashFlow	Cash flow of the business.
yearOfIncorporation Required	Year string	Year of incorporation of the business.
countriesOfOperation Optional	Array of ISO31661-Alpha2 strings	An array of two letter codes representing the countries of operation of the business.
stockSymbol Optional	string	The stock symbol (ticker) of the business.
businessVertical Required	BusinessVertical	The business vertical of the business.
ip Optional	string	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 Required	boolean	Indicates whether the application has been archived. Archived applications are read-only and no changes can be made to them. An application becomes archived once the corresponding customer is archived.
tags Required	object	See Tags.

Relationships

Name	Type	Description
documents Optional	Array of JSON:API Relationship	Application's documents.
customer Optional	JSON:API Relationship	The created Customer in case of approved application.
applicationForm Optional	JSON:API Relationship	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,
    "annualRevenue": "Between500kAnd1m",
    "numberOfEmployees": "Between50And100",
    "cashFlow": "Predictable",
    "yearOfIncorporation": "2014",
    "countriesOfOperation": [
      "US"
    ],
    "stockSymbol": "PPI",
    "businessVertical": "TechnologyMediaOrTelecom",
    "website": "https://www.piedpiper.com",
    "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:

Name	Type	Description
id Required	string	Identifier of the business resource.
type Required	string	Type of the resource, the value is always businessCustomer.
attributes Required	JSON Object	JSON object representing the business data.
relationships Required	JSON:API Relationships	Describes relationships between the customer resource, the Org it belongs to, and the Application it was created by.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
name Required	string	Name of the business.
dba Optional	string	"Doing business as".
address Required	Address	Address of the business.
operatingAddress Optional	Address	The operating address of the business.
phone Required	Phone	Phone of the business.
stateOfIncorporation Required	string	Two letters representing a US state.
ein Required	string	Business EIN (numbers only).
entityType Required	string	One of LLC, Partnership, PubliclyTradedCorporation, PrivatelyHeldCorporation or NotForProfitOrganization.
contact Required	BusinessContact	Primary contact of the business.
annualRevenue Optional	AnnualRevenue	Annual revenue of the business.
numberOfEmployees Optional	NumberOfEmployees	Number of employees of the business.
businessVertical Optional	BusinessVertical	Business vertical of the business.
cashFlow Optional	CashFlow	Cash flow of the business.
countriesOfOperation Optional	Array of ISO31661-Alpha2 strings	Countries where the business operates.
website Optional	string	Business's website.
stockSymbol Optional	string	The stock symbol (ticker) of the business.
yearOfIncorporation Optional	Year string	Year of incorporation of the business.
authorizedUsers Required	Array of AuthorizedUser	Array of authorized users. An authorized user is someone who can participate in the One Time Password (OTP) authentication process.
status Required	string	Status of the customer, either Active or Archived. You can't do any write operations on an Archived customer.
eligibleProducts Optional	Array of Product	The products that the customer is eligible for.
archiveReason	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.
tags Required	object	See Tags. Inherited from the application tags (see Tag Inheritance).

Relationships

Name	Type	Description
org Required	JSON:API Relationship	The Org of the business.
application Required	JSON:API Relationship	The Application that created this business.
authorizedUserResources Required	JSON:API Relationship	A list of the related AuthorizedUser.
officer Required	Optional, JSON:API Relationship	The related Officer resource for this business customer.
beneficialOwners Required	Optional, array of JSON:API Relationship	The related BeneficialOwner resources for this business customer.

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",
    "businessVertical": "TechnologyMediaOrTelecom",
    "numberOfEmployees": "Between50And100",
    "annualRevenue": "Between500kAnd1m",
    "cashFlow": "Predictable",
    "countriesOfOperation": [
      "US",
      "CA"
    ],
    "website": "https://piedpiper.com",
    "stockSymbol": "PPI",
    "yearOfIncorporation": "2014",
    "operatingAddress": {
      "street": "5250 Newell Rd",
      "street2": null,
      "city": "Palo Alto",
      "state": "CA",
      "postalCode": "94303",
      "country": "US"
    },
    "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"
      }
    },
    "officer": {
      "data": {
        "type": "officer",
        "id": "12"
      }
    },
    "beneficialOwners": {
      "data": [
        {
          "type": "beneficialOwner",
          "id": "45"
        }
      ]
    },
    "authorizedUserResources": {
      "data": [
        {
          "type": "authorizedUserResource",
          "id": "1"
        },
        {
          "type": "authorizedUserResource",
          "id": "2"
        }
      ]
    }
  }
}

BusinessDebitCard

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

Name	Type	Description
id Required	string	Identifier of the card resource.
type Required	string	Type of the card resource. For business debit card the value is always BusinessDebitCard.
attributes Required	JSON Object	JSON object representing the card data.
relationships Required	JSON:API Relationships	Describes relationships between the card resource and other resources (account and customer).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Optional	RFC3339 Date string	The date the resource was updated.
last4Digits Required	string	Last 4 digits of the debit card.
expirationDate Required	string	Card expiration date, formatted YYYY-MM, e.g "2020-05".
shippingAddress Optional	Address	Shipping address, if specified.
ssn Optional	string	SSN of the card holder (numbers only), if specified during card creation.
passport Optional	string	Passport number of the card holder, if specified during card creation.
nationality	ISO31661-Alpha2 string	Required if a passport is used as the main ID and optional when ssn is used. Two letters representing the card holder nationality. (e.g. "US").
fullName Required	FullName	Full name of the card holder.
dateOfBirth Required	RFC3339 Date string	Date of birth of the card holder (e.g. "2001-08-15").
address Required	Address	Address of the card holder.
bin Required	string	9-digit Bank Identification Number (BIN).
phone Required	Phone	Phone of the card holder.
email Required	string	Email address of the card holder.
status Required	string	Status of the card, one of: Active, Inactive, Stolen, Lost, Frozen, ClosedByCustomer, SuspectedFraud.
design Optional	string	Card design, if specified.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	Account the card belong to.
customer Required	JSON:API Relationship	Holder of the account.

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:

Name	Type	Description
id Required	string	Identifier of the business resource.
type Required	string	Type of the resource, the value is always businessFBOCustomer.
attributes Required	JSON Object	JSON object representing the business data.
relationships Required	JSON:API Relationships	Describes relationships between the customer resource, the Org it belongs to, and the Application it was created by.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
businessName Required	string	Name of the business.
name Required	string	The official name
businessVertical Required	BusinessVertical	The business vertical of the business.
bankName Required	string	the name of the bank.
numberOfEmployees Required	NumberOfEmployees	Number of employees of the business.
address Required	Address	Address of the business.
tags Optional	object	See Tags.
authorizedUsers Required	Array of AuthorizedUser	Array of authorized users. An authorized user is someone who can participate in the One Time Password (OTP) authentication process.

Relationships

Name	Type	Description
org Required	JSON:API Relationship	The Org of the business.
authorizedUserResources Required	JSON:API Relationship	A list of the related AuthorizedUser.

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:

Name	Type	Description
id Required	string	Identifier of the card resource.
type Required	string	Type of the card resource. For business virtual debit card the value is always businessVirtualDebitCard.
attributes Required	JSON Object	JSON object representing the card data.
relationships Required	JSON:API Relationships	Describes relationships between the card resource and other resources (account and customer).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Optional	RFC3339 Date string	The date the resource was updated.
last4Digits Required	string	Last 4 digits of the debit card.
expirationDate Required	string	Card expiration date, formatted YYYY-MM, e.g "2020-05".
ssn Optional	string	SSN of the card holder (numbers only), if specified during card creation.
passport Optional	string	Passport number of the card holder, if specified during card creation.
nationality	ISO31661-Alpha2 string	Required if a passport is used as the main ID and optional when ssn is used. Two letters representing the card holder nationality. (e.g. "US").
fullName Required	FullName	Full name of the card holder.
dateOfBirth Required	RFC3339 Date string	Date of birth of the card holder (e.g. "2001-08-15").
address Required	Address	Address of the card holder.
bin Required	string	9-digit Bank Identification Number (BIN).
phone Required	Phone	Phone of the card holder.
email Required	string	Email address of the card holder.
status Required	string	Status of the card, one of: Active, Inactive, Stolen, Lost, Frozen, ClosedByCustomer, SuspectedFraud.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	Account the card belong to.
customer Required	JSON:API Relationship	Holder of the account.

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:

Name	Type	Description
id Required	string	Identifier of the business wallet customer resource.
type Required	string	Type of the resource, the value is always businessWalletCustomer.
attributes Required	JSON Object	JSON object representing the business data.
relationships Required	JSON:API Relationships	Describes relationships between the customer resource and the Org it belongs to.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
bankName Required	string	The name of the bank partner this customer is about to create a wallet under.
businessName Required	string	The name of the business this customer represents.
name Required	string	The official name.
address Required	Address	Address of the business.
ein Required	string	Business EIN (numbers only).
businessVertical Required	BusinessVertical	The business vertical of the business.
numberOfEmployees Required	NumberOfEmployees	The number of employees working for this business.
tags Optional	object	See Tags.

Relationships

Name	Type	Description
org Required	JSON:API Relationship	The Org of the business.

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:

Name	Type	Description
id Required	string	Identifier of the Capital Partner repayment resource.
type Required	string	Type of the payment resource. For capital partner ACH repayment the value is capitalPartnerAchRepayment.
attributes Required	JSON Object	JSON object representing the repayment resource.
relationships Required	JSON:API Relationships	Describes relationships between the capital partner ACH repayment and the credit account.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Required	RFC3339 Date string	The date the resource was updated.
amount Required	integer	The amount (cents) of the payment.
status Required	string	Either Pending, PendingReview, Returned, Sent or Rejected
tags Required	object	See Tags.

Relationships

Name	Type	Description
creditAccount Required	JSON:API Relationship	The Credit Account the repayment is made for.
counterparty Required	JSON:API Relationship	The Counterparty the repayment to be made from.
org Required	JSON:API Relationship	The org the customer belongs to.
customer Required	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 Required	JSON:API Relationship	The payment created between the capital partner's account and the counterparty
recurringRepayment Required	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:

Name	Type	Description
id Required	string	Identifier of the Capital Partner repayment resource.
type Required	string	Type of the payment resource. For capital partner book repayment the value is capitalPartnerBookRepayment.
attributes Required	JSON Object	JSON object representing the repayment resource.
relationships Required	JSON:API Relationships	Describes relationships between the capital partner book repayment and the credit account.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Required	RFC3339 Date string	The date the resource was updated.
amount Required	integer	The amount (cents) of the payment.
status Required	string	Either Pending, PendingReview, Returned, Sent or Rejected
tags Required	object	See Tags.

Relationships

Name	Type	Description
creditAccount Required	JSON:API Relationship	The Credit Account the repayment is made for.
counterpartyAccount Required	JSON:API Relationship	The Deposit Account the repayment to be made from.
org Required	JSON:API Relationship	The org the customer belongs to.
customer Required	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 Required	JSON:API Relationship	The payment created between the capital partner's account and the counterparty
recurringRepayment Required	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:

Name	Type	Description
id Required	string	Identifier of the card fraud outreach policy resource.
type Required	string	Type of the card fraud outreach policy resource. The value is always cardFraudOutreachPolicy
attributes Required	JSON Object	JSON object representing the card fraud outreach policy data.
relationships Required	JSON:API Relationships	Describes relationships between the card fraud outreach policy resource and other resources.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
activitiesLookBackPeriodHours Required	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, 72
caseExpirationPeriodHours Required	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.
numberOfCardActivities Required	integer	The number of card activities that are included in the card fraud case. Up to 5 activities max.
businessRecipient Optional	string	For business cards, controls who receives the fraud outreach email. One of: CardHolder or CustomerAndCardHolder. When omitted or null, email goes to the cardholder only.
contactPhone Required	Phone	The client support contact phone number.
contactUrl Required	string	The client support contact URL.
enabled Required	boolean	Indicates whether the policy is enabled.

Relationships

Name	Type	Description
emailOutreachSettings Required	JSON:API Relationship	The EmailOutreachSettings that is associated to the card fraud outreach policy, if it was set on.
whiteLabelTheme Required	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,
      "numberOfCardActivities": 3,
      "businessRecipient": "CardHolder",
      "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:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always cardReversalTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account, customer and relatedTransaction).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
cardLast4Digits Required	string	The last 4 digits of the debit card involved in the transaction.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
relatedTransaction Optional	JSON:API Relationship	The transaction which the reversal is related to.
card Required	JSON:API Relationship	The debit card used in the purchase.

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:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always cardTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account and customer).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
cardLast4Digits Required	string	The last 4 digits of the debit card involved in the transaction.
merchant.name Optional	string	The name of the merchant.
merchant.type Optional	integer	The 4-digit ISO 18245 merchant category code (MCC).
merchant.category Optional	string	The merchant category, described by the MCC code (see this reference for the list of category descriptions).
merchant.location Optional	string	The location (city, state, etc.) of the merchant.
merchant.id Optional	string	The unique network merchant identifier.
recurring Optional	boolean	Indicates whether the transaction is recurring.
interchange Optional	string	The interchange share for this transaction. Calculated at the end of each day, see the transaction.updated event.
grossInterchange Optional	string	The gross interchange share for this transaction.
paymentMethod Optional	string	The payment method used, one of: Manual, Swipe, Contactless, ChipAndPin, Stored, Other.
digitalWallet Optional	string	The type of digital wallet used, one of: Google, Apple, Other.
cardVerificationData.verificationMethod Optional	string	The verification method used, one of: Address, CVV2, AddressAndCVV2.
cardNetwork Optional	string	The card network used, one of: Visa, Interlink, Accel, Allpoint, Other.
richMerchantData Optional	Rich Merchant Data	Full merchant information.
tags Required	object	See Tags.
currencyConversion Optional	Currency Conversion	When original currency for transaction is not USD.
cardDecisionSource Optional	string	Who made the final card authorization decision. See Understanding authorization decisions. One of Org, Unit, Network, TimeoutApprove, TimeoutDecline, DefaultApprove, InternalError, IssuerStandIn.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
authorization Optional	JSON:API Relationship	The Authorization request made, if present (see Authorizations).
card Required	JSON:API Relationship	The debit card used in the purchase.

Example CardTransaction resource:

{
  "type": "cardTransaction",
  "id": "410",
  "attributes": {
    "createdAt": "2020-09-20T12:41:43.360Z",
    "direction": "Debit",
    "amount": 10,
    "balance": 89480,
    "summary": "Card transaction details",
    "cardLast4Digits": "2282",
    "merchant": {
      "name": "Europcar Mobility Group",
      "type": 3381,
      "category": "EUROP CAR",
      "location": "Cupertino, CA",
      "id": "029859000085093"
    },
    "recurring": false,
    "interchange": "2.43",
    "grossInterchange": "200.00",
    "paymentMethod": "Contactless",
    "digitalWallet": "Apple",
    "cardVerificationData": {
      "verificationMethod": "CVV2"
    },
    "cardNetwork": "Visa",
    "cardDecisionSource": "Org"
  },
  "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:

Name	Type	Description
id Required	string	Identifier of the card transaction authorization request resource.
type Required	string	Type of the card transaction authorization request resource. The value is always cardTransactionAuthorizationRequest.
attributes Required	JSON Object	JSON object representing the authorization request data.
relationships Required	JSON:API Relationships	Describes relationships between the authorization request resource and other resources (account, customer and card).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the authorization request was created.
amount Required	integer	The amount (cents) of the authorization request.
status Required	string	The status of the authorization request. Either Pending, Approved or Declined.
partialApprovalAllowed Required	boolean	Indicates whether the authorization request supports partial amount approval.
approvedAmount Optional	integer	The amount (cents) that was approved. Available only when status is Approved.
declineReason Optional	string	The reason the authorization request was declined. One of AccountClosed, CardExceedsAmountLimit, DoNotHonor, InsufficientFunds, InvalidMerchant, ReferToCardIssuer, RestrictedCard, Timeout, TransactionNotPermittedToCardholder. Available only when status is Declined
merchant.name Required	string	The name of the merchant.
merchant.type Required	integer	The 4-digit ISO 18245 merchant category code (MCC).
merchant.category Required	string	The merchant category, described by the MCC code (see this reference for the list of category descriptions).
merchant.location Optional	string	The location (city, state, etc.) of the merchant.
merchant.id Optional	string	The unique network merchant identifier.
recurring Required	boolean	Indicates whether the authorization is recurring
paymentMethod Optional	string	The payment method used, one of: Manual, Swipe, Contactless, ChipAndPin, Stored, Other.
digitalWallet Optional	string	The type of digital wallet used, one of: Google, Apple, Other.
cardVerificationData. verificationMethod Optional	string	The verification method used, one of: Address, CVV2, AddressAndCVV2.
cardNetwork Optional	string	The card network used, one of: Visa, Interlink, Accel, Allpoint, Other.
tags	object	Optional, See Tags. If specified when approving the authorization request.
currencyConversion Optional	Currency Conversion	When original currency for transaction is not USD.
isInternational Optional	boolean	Indicates whether the transaction is international.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
card Required	JSON:API Relationship	The debit card used in the transaction.
fundingAccount Required	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:

Name	Type	Description
type Required	string	Type of the authorization request resource. The value is always pendingAuthorizationRequest.
id Required	string	The authorization request id
attributes Required	JSON Object	JSON object representing the authorization request data.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
available Required	integer	The available balance for spending (in cents).
status Required	string	The status of the request. will be always "Pending"
partialApprovalAllowed Required	boolean	Indicates whether the authorization request supports partial amount approval.
merchant.name Required	string	The name of the merchant.
merchant.type Required	integer	The 4-digit ISO 18245 merchant category code (MCC).
merchant.location Optional	string	The location (city, state, etc.) of the merchant.
merchant.id Optional	string	The unique network merchant identifier.
recurring Required	boolean	Indicates whether the authorization is recurring
direction Required	string	The direction in which the funds flow (either Debit or Credit).
mustBeApproved Required	boolean	Indicates whether the authorization request must be approved.
idempotencyKey Required	string	See Idempotency
tags Required	object	See Tags.
paymentMethod Optional	string	The payment method used, one of: Manual, Swipe, Contactless, ChipAndPin, Stored, Other.
currencyConversion Optional	Currency Conversion	When original currency for transaction is not USD.
isInternational Optional	boolean	Indicates whether the transaction is international.
cardNetwork Optional	string	The network that this card is a part of, e.g. Visa, Interlink, etc.

Name	Type	Description
account Required	JSON:API Relationship	The account of the customer creating the atm transaction.
customer Required	JSON:API Relationship	The customer that created the atm transaction.
card Required	JSON:API Relationship	The debit card used in the transaction.
authorizationRequest Required	JSON:API Relationship	The authorization request.

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:

Name	Type	Description
type Required	string	Type of the Cash Deposit Barcode resource. The value is always cashDepositBarcode.
attributes Required	JSON Object	JSON object representing the Cash Deposit Barcode data.

Attributes

Name	Type	Description
barcodeNumber Required	string	Unique identifier of the barcode. This field will be used in Get Barcode Image by Barcode Number endpoint.
expiration Required	ISO 8601 Date and time string	The expiration date and time of the barcode
storeId Required	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 Required	string	Name of the retailer store that supports Cash Deposits.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account designated to receive the payment.
customer Required	JSON:API Relationship	The Customer the deposit account belongs to.

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:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always cashDepositTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
tags Required	object	See Tags. Inherited from the payment tags (see Tag Inheritance).

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	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:

Name	Type	Description
id Required	string	Identifier of the chargeback resource.
type Required	string	Type of the chargeback resource. The value is always chargeback.
attributes Required	JSON Object	JSON object representing the fee data.
relationships Required	JSON:API Relationships	Describes relationships between the chargeback resource and other resources (accounts, transaction, customer).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the chargeback was created.
amount Required	integer	The amount (in cents) of the chargeback.
description Required	string	Description of the chargeback.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account the funds will be debited from.
customer Required	JSON:API Relationship	The Customer the deposit account belongs to.
counterpartyAccount Required	JSON:API Relationship	The account that will receive the funds.
transaction Required	JSON:API Relationship	The Chargeback Transaction generated by this chargeback.

Example Chargeback resource:

{
  "type": "chargeback",
  "id": "2",
  "attributes": {
    "createdAt": "2022-03-24T17:36:47.638Z",
    "amount": 5000,
    "description": "Chargeback for dispute #1337",
    "tags": {
      "internalId": "abc1345"
    }
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "10006"
      }
    },
    "customer": {
      "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:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always chargebackTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (accounts, customer, chargeback).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types, this will be the description of the chargeback.
counterparty Required	Counterparty	The party on the other end of the transaction.
tags Required	object	See Tags. Inherited from the payment tags (see Tag Inheritance).

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
counterpartyAccount Required	JSON:API Relationship	The account of the counterparty.
chargeback Required	JSON:API Relationship	The chargeback belonging to this transaction.

Example ChargebackTransaction resource:

{
  "type": "chargebackTransaction",
  "id": "9547",
  "attributes": {
    "createdAt": "2020-07-05T15:49:36.864Z",
    "direction": "Debit",
    "amount": 1000,
    "balance": 12000,
    "summary": "Chargeback for dispute #1337",
    "counterparty": {
      "name": "Jane Smith",
      "routingNumber": "812345678",
      "accountNumber": "10039",
      "accountType": "Checking"
    },
    "tags": {
      "internalId": "abc1345"
    }
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "10035"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "10000"
      }
    },
    "customers": {
      "data": [
        {
          "type": "customer",
          "id": "10000"
        }
      ]
    },
    "counterpartyAccount": {
      "data": {
        "type": "account",
        "id": "10036"
      }
    },
    "chargeback": {
      "data": {
        "type": "chargeback",
        "id": "10530"
      }
    }
  }
}

Check Deposit

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

Name	Type	Description
id Required	string	Identifier of the check deposit resource.
type Required	string	Type of the check deposit resource. The value is always checkDeposit.
attributes Required	JSON Object	JSON object representing the check deposit resource.
relationships Required	JSON:API Relationships	Describes relationships between the check deposit resource and other resources

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
status Required	string	One of AwaitingImages, AwaitingFrontImage, AwaitingBackImage, Pending, PendingReview, Rejected, Clearing, Sent, Canceled, Returned.
reason Optional	string	More information about the status.
description Required	string	Check Deposit description (maximum of 50 characters).
amount Required	string	The amount (cents) of the check deposit.
checkNumber Optional	string	The serial number printed at the bottom of the check
counterparty Optional	Check Counterparty	The party the check belongs to.
clearingDaysOverride Optional	integer	The amount of days it will take a check deposit to clear if a clearingDaysOverride was provided. See Dynamic Clearing Period
settlementDate	RFC3339 Date string	Optional, For Pending or Clearing, shows the date on which the check will be settled.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account receiving the check deposit.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
transaction Required	JSON:API Relationship	The Check Deposit Transaction generated by this check deposit.

Example CheckDeposit resource:

{
  "data": {
    "type": "checkDeposit",
    "id": "11221",
    "attributes": {
      "createdAt": "2021-05-27T09:29:30.828Z",
      "amount": 20000,
      "description": "Check deposit",
      "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:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always checkDepositTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account, customer, checkDeposit).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account participating in the transaction.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
checkDeposit Required	JSON:API Relationship	The Check Deposit the transaction is related to.

Example CheckDepositTransaction resource:

{
  "data": {
    "type": "checkDepositTransaction",
    "id": "264",
    "attributes": {
      "createdAt": "2021-06-06T07:21:51.467Z",
      "amount": 200,
      "direction": "Credit",
      "balance": 371600,
      "summary": "Check deposit"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "account",
          "id": "10001"
        }
      },
      "customer": {
        "data": {
          "type": "customer",
          "id": "10000"
        }
      },
      "checkDeposit": {
        "data": {
          "type": "checkDeposit",
          "id": "122"
        }
      }
    }
  }
}

Check Payment

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

Name	Type	Description
id Required	string	Identifier of the check payment resource.
type Required	string	Type of the check payment resource. The value is always checkPayment.
attributes Required	JSON Object	JSON object representing the check payment resource.
relationships Required	JSON:API Relationships	Describes relationships between the check payment resource and other resources

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Required	RFC3339 Date string	The date the resource was updated.
status Required	string	One of New, Pending, PendingCancellation, Canceled,InDelivery, Delivered, ReturnedToSender, Processed, PendingReview, MarkedForReturn, Returned, Rejected.
amount Required	integer	The amount (cents) of the check deposit.
description Required	string	Description of the Check Payment.
checkNumber Optional	string	The serial number printed at the bottom of the check
originated Required	boolean	True for checks originated through Unit
onUs Optional	string
onUsAuxiliary Optional	string
counterpartyRoutingNumber Optional	string	The routing number of the party that deposited the Check.
returnStatusReason Optional	string	The reason the Check Payment have been marked for return or returned. See Check Payment return reasons.
rejectReason Optional	string
pendingReviewReasons Optional	Array of strings	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.
returnCutoffTime Optional	RFC3339 Date string	The last time when a return will be accepted using the return Check Payment endpoint.
additionalVerificationStatus	string	Optional. One of 'Required', 'NotRequired' or 'Approved', when Requires an additional verification will be required, see Approve Additional Verification.
tags Required	object	See Tags.
deliveryStatus Optional	string	One of Mailed, InLocalArea, Delivered, Rerouted, ReturnedToSender. Available once check status is InDelivery
trackedAt Optional	RFC3339 Date string	The date of the last delivery status update.
postalCode Optional	String	The location of the last delivery status update.
expirationDate Optional	String	check expiration date, formatted YYYY-MM--DD, e.g "2020-05-01".
expectedDelivery Required	String	check expected delivery date, formatted YYYY-MM--DD, e.g "2020-05-01".
sendAt Optional	RFC3339 Date string	The date and time in which the check is to be sent.
counterparty Required	Optional. Check payment counterparty	The receiving party of the check.
memo Optional	String	Text included on the memo line of the check.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account receiving the check payment and will be debited for it.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
transaction Required	JSON:API Relationship	The Check Payment Transaction generated by this check deposit.

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:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always checkPaymentTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account, customer, checkPayment).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account participating in the transaction.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
checkPayment Required	JSON:API Relationship	The Check Payment the transaction is related to.

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:

Name	Type	Description
id Required	string	Identifier of the check stop payment resource.
type Required	string	Type of the stop payment resource. The value is always checkStopPayment.
attributes Required	JSON Object	JSON object representing the check stop payment resource.
relationships Required	JSON:API Relationships	Describes relationships between the check stop payment resource and other resources

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Required	RFC3339 Date string	The date the resource was updated.
amount Optional	integer	The amount (cents) of the check payment.
status Required	string	The status of the stop payment, one of Active or Disabled.
checkNumber Required	string	The checkNumber of the check payments that the stop payment operation will be applied to.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account receiving the check payment and will be debited for it.
customer Required	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 Required	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 Required	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:

Name	Type	Description
id Required	string	Identifier of the Counterparty.
type Required	string	Type of the balance. for counterparty balance the value is always counterpartyBalance.
attributes Required	JSON Object	JSON object representing the counterparty balance resource.
relationships Required	JSON:API Relationships	Describes relationships between the counterparty balance and the customer and counterparty.

Attributes

Name	Type	Description
balance Required	number	The current balance amount (in cents) of the counterparty.
available Optional	number	The available balance amount (in cents) of the counterparty.

Relationships

Name	Type	Description
counterparty Required	JSON:API Relationship	The counterparty the balance belongs to.
customer Required	JSON:API Relationship	The customer the counterparty belongs to.

Example Counterparty Balance resource:

{
  "data": {
    "type": "counterpartyBalance",
    "id": "2",
    "attributes": {
      "balance": 11000,
      "available": 10000
    },
    "relationships": {
      "counterparty": {
        "data": {
          "type": "counterparty",
          "id": "2"
        }
      },
      "customer": {
        "data": {
          "type": "customer",
          "id": "10000"
        }
      }
    }
  }
}

Credit Application Decision

Manual Review Credit Application Decision

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

Name	Type	Description
id Required	string	Identifier of the credit decision resource.
type Required	string	Type of the credit decision resource. The value is always manualReviewCreditApplicationDecision.
attributes Required	JSON Object	JSON object representing the credit decision data.
relationships Required	JSON:API Relationships	Describes relationships between the credit decision resource and other resources.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
externalApplicationId Required	string	Identifier for client's credit evaluation related to this decision. Max 200 char.
evaluationType Required	string	The type of credit decision. This is always CreditApplication.
submissionTimestamp Required	timestamp	Timestamp when the corresponding credit application was submitted.
decisionTimestamp Required	timestamp	Timestamp when the credit decision was made.
decision Required	string	The Decision for this credit application. This is always ManualReview.
policyException Required	boolean	One of true or false.
policyExceptionReason Required	string	Conditional if policyException is true. Brief description of reason for policy exception. Max 200 char.
additionalUnderwritingData Required	json	Object containing key-value pairs of underwriting data per credit policy.

Relationships

Name	Type	Description
application Required	JSON:API Relationship	The Application for which this credit decision applies to.
creditApplication Optional	JSON:API Relationship	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:

Name	Type	Description
id Required	string	Identifier of the credit decision resource.
type Required	string	Type of the credit decision resource. The value is always approvedCreditApplicationDecision.
attributes Required	JSON Object	JSON object representing the credit decision data.
relationships Required	JSON:API Relationships	Describes relationships between the credit decision resource and other resources.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
externalApplicationId Required	string	Identifier for client's credit evaluation related to this decision. Max 200 char.
evaluationType Required	string	The type of credit decision. This is always CreditApplication.
submissionTimestamp Required	timestamp	Timestamp when the corresponding credit application was submitted.
decisionTimestamp Required	timestamp	Timestamp when the credit decision was made.
decision Required	string	The Decision for this credit application. This is always Approved.
policyException Required	boolean	One of true or false.
policyExceptionReason Required	string	Conditional if policyException is true. Brief description of reason for policy exception. Max 200 char.
additionalUnderwritingData Required	json	Object containing key-value pairs of underwriting data per credit policy.
creditLimit Required	Integer (Cents)	Credit limit for application as evaluated per policy.

Relationships

Name	Type	Description
application Required	JSON:API Relationship	The Application for which this credit decision applies to.
creditApplication Optional	JSON:API Relationship	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:

Name	Type	Description
id Required	string	Identifier of the credit decision resource.
type Required	string	Type of the credit decision resource. The value is always deniedCreditApplicationDecision.
attributes Required	JSON Object	JSON object representing the credit decision data.
relationships Required	JSON:API Relationships	Describes relationships between the credit decision resource and other resources.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
externalApplicationId Required	string	Identifier for client's credit evaluation related to this decision. Max 200 char.
evaluationType Required	string	The type of credit decision. This is always CreditApplication.
submissionTimestamp Required	timestamp	Timestamp when the corresponding credit application was submitted.
decisionTimestamp Required	timestamp	Timestamp when the credit decision was made.
decision Required	string	The Decision for this credit application. This is always Denied.
policyException Required	boolean	One of true or false.
policyExceptionReason Required	string	Conditional if policyException is true. Brief description of reason for policy exception. Max 200 char.
additionalUnderwritingData Required	json	Object containing key-value pairs of underwriting data per credit policy.
decisionReason Required	string	Reason for denial per credit policy. Max 200 char.
adverseActionReasons Required	Array of strings	Array of strings representing Adverse action reasons (must have at least one). Max 200 char per reason.

Relationships

Name	Type	Description
application Required	JSON:API Relationship	The Application for which this credit decision applies to.
creditApplication Optional	JSON:API Relationship	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:

Name	Type	Description
id Required	string	Identifier of the credit decision resource.
type Required	string	Type of the credit decision resource. The value is always manualReviewCreditLimitDecision.
attributes Required	JSON Object	JSON object representing the credit decision data.
relationships Required	JSON:API Relationships	Describes relationships between the credit decision resource and other resources.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
externalApplicationId Required	string	Identifier for client's credit evaluation related to this decision. Max 200 char.
evaluationType Required	string	The type of credit decision. This is always CreditLimit.
submissionTimestamp Required	timestamp	Timestamp when the corresponding credit application was submitted.
decisionTimestamp Required	timestamp	Timestamp when the credit decision was made.
decision Required	string	The Decision for this credit application. This is always ManualReview.
policyException Required	boolean	One of true or false.
policyExceptionReason Required	string	Conditional if policyException is true. Brief description of reason for policy exception. Max 200 char.
additionalUnderwritingData Required	json	Object containing key-value pairs of underwriting data per credit policy.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Credit Account for which this credit decision applies to.
creditApplication Optional	JSON:API Relationship	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:

Name	Type	Description
id Required	string	Identifier of the credit decision resource.
type Required	string	Type of the credit decision resource. The value is always approvedCreditLimitDecision.
attributes Required	JSON Object	JSON object representing the credit decision data.
relationships Required	JSON:API Relationships	Describes relationships between the credit decision resource and other resources.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
externalApplicationId Required	string	Identifier for client's credit evaluation related to this decision. Max 200 char.
evaluationType Required	string	The type of credit decision. This is always CreditLimit.
submissionTimestamp Required	timestamp	Timestamp when the corresponding credit application was submitted.
decisionTimestamp Required	timestamp	Timestamp when the credit decision was made.
decision Required	string	The Decision for this credit application. This is always Approved.
policyException Required	boolean	One of true or false.
policyExceptionReason Required	string	Conditional if policyException is true. Brief description of reason for policy exception. Max 200 char.
additionalUnderwritingData Required	json	Object containing key-value pairs of underwriting data per credit policy.
creditLimit Required	Integer (Cents)	Credit limit for application as evaluated per policy.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Credit Account for which this credit decision applies to.
creditApplication Optional	JSON:API Relationship	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:

Name	Type	Description
id Required	string	Identifier of the credit decision resource.
type Required	string	Type of the credit decision resource. The value is always deniedCreditLimitDecision.
attributes Required	JSON Object	JSON object representing the credit decision data.
relationships Required	JSON:API Relationships	Describes relationships between the credit decision resource and other resources.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
externalApplicationId Required	string	Identifier for client's credit evaluation related to this decision. Max 200 char.
evaluationType Required	string	The type of credit decision. This is always CreditLimit.
submissionTimestamp Required	timestamp	Timestamp when the corresponding credit application was submitted.
decisionTimestamp Required	timestamp	Timestamp when the credit decision was made.
decision Required	string	The Decision for this credit application. This is always Denied.
policyException Required	boolean	One of true or false.
policyExceptionReason Required	string	Conditional if policyException is true. Brief description of reason for policy exception. Max 200 char.
additionalUnderwritingData Required	json	Object containing key-value pairs of underwriting data per credit policy.
decisionReason Required	string	Reason for denial per credit policy. Max 200 char.
adverseActionReasons Required	Array of strings	Array of strings representing Adverse action reasons (must have at least one). Max 200 char per reason.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Credit Account for which this credit decision applies to.
creditApplication Optional	JSON:API Relationship	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:

Name	Type	Description
id Required	string	Identifier of the credit account resource.
type Required	string	Type of the resource. Currently only creditAccount is supported.
attributes Required	JSON Object	JSON object representing the credit account data.
relationships Required	JSON:API Relationships	Describes relationships between the credit account resource and the customer.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Optional	RFC3339 Date string	The date the resource was updated.
name Required	string	Name of the account holder.
creditTerms Required	string	The selected credit terms.
currency Required	string	Currency of the account.
creditLimit Required	integer	The credit limit (cents).
balance Required	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 Required	integer	The hold amount (cents). The hold represents funds that are not available for spending, due to an outstanding card authorization.
available Required	integer	The available balance for spending (cents). Equals the credit limit, minus the balance and hold amounts.
tags Required	object	See Tags.
status Required	string	Status of the account, either Open, Frozen, or Closed.
freezeReason Optional	string	The reason the account was frozen, either Fraud, ByBank, or free-text description.
closeReason Optional	string	The reason the account was closed, either ByCustomer, Overdue or Fraud.
closeReasonText Optional	string	An expanded free-text reason for account closure.
fraudReason Optional	string	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

Name	Type	Description
customer Required	Optional, populated if account has a single owner. JSON:API Relationship	The customer.

Example CreditAccount Resource:

{
  "data": {
    "type": "creditAccount",
    "id": "42",
    "attributes": {
      "createdAt": "2000-05-11T10:19:30.409Z",
      "name": "Peter Parker",
      "status": "Open",
      "creditTerms": "credit_terms_1",
      "currency": "USD",
      "balance": 10000,
      "hold": 0,
      "available": 10000,
      "tags": {
        "purpose": "some_purpose"
      },
      "creditLimit": 200000
    },
    "relationships": {
      "customer": {
        "data": {
          "type": "customer",
          "id": "45555"
        }
      },
      "org": {
        "data": {
          "type": "org",
          "id": "1"
        }
      }
    }
  }
}

Denied Credit Application

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

Name	Type	Description
id Required	string	Identifier of the application resource.
type Required	string	Type of the credit application resource. For existingCustomerCreditApplication the value is always existingCustomerCreditApplication.
attributes Required	JSON Object	JSON object representing the credit application data.
relationships Required	JSON:API Relationships	Describes relationships between the credit application resource and other resources.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
status Required	string	The status of the credit application. will be always Denied.
aggregatorAccessTokens Optional	Array of string	Array of aggregator access tokens which are Plaid (or other account linking platform) integration tokens. See Plaid processor token
annualIncome Optional	Integer (Cents)	The annual income of the applicant.
numberOfEmployees Optional	NumberOfEmployees	Number of employees of the business.
yearsInBusiness Optional	Integer	Number of years the business has been in operation.
additionalUnderwritingData Optional	json	Object containing key-value pairs of underwriting data per credit policy.

Relationships

Name	Type	Description
application Required	JSON:API Relationship	The Application to which this credit application applies to.
lendingProgram Required	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:

Name	Type	Description
id Required	string	Identifier of the deposit account resource.
type Required	string	Type of the resource, the value is always depositAccount.
attributes Required	JSON Object	JSON object representing the deposit account data.
relationships Required	JSON:API Relationships	Describes relationships between the deposit account resource and the customer.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Optional	RFC3339 Date string	The date the resource was updated.
name Required	string	Name of the account holder.
depositProduct Required	string	The name of the deposit product.
routingNumber Required	string	Routing number of account.
accountNumber Required	string	Account number, together with the routingNumber forms the identifier of the account on the ACH network.
currency Required	string	Currency of the account.
balance Required	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 Required	integer	The hold amount (in cents). The hold represents funds that are not available for spending, due to an outstanding card authorization.
available Required	integer	The available balance for spending (in cents). Equals the balance minus the hold amount.
tags Required	object	See Tags.
status Required	string	Status of the account, either Open, Frozen, or Closed.
interestTerms Required	Total Accrued Interest	The interest terms of the deposit account. Only available if extraFields[account] is used when calling the Get Account by Id endpoint.
freezeReason Optional	string	The reason the account was frozen, either Fraud, ByBank, or free-text description.
closeReason Optional	string	The reason the account was closed, either ByCustomer,Fraud or ByBank.
fraudReason Optional	string	The expanded fraud reason for closing the account when Fraud is specified as the reason. Can be one of: (ACHActivity, CardActivity, CheckActivity, ApplicationHistory, AccountActivity, ClientIdentified, IdentityTheft, LinkedToFraudulentCustomer).
dacaStatus Optional	string	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

Name	Type	Description
customer Required	Optional, populated if account has a single owner. JSON:API Relationship	The customer.
customers Required	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:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always dishonoredAchTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account and customer).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
description Required	string	Transaction description.
companyName Required	string	The name by which the originator is known to the receiver.
counterpartyRoutingNumber Required	string	The routing number of the party that originated the ACH payment.
traceNumber Required	string	The ACH Trace Number.
reason Required	string	The reason for the dishonored return.
secCode Optional	string	The 3-letter ACH Standard Entry Class (SEC) Code (e.g. WEB, CCD, PPD, etc.).
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	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:

Name	Type	Description
id Required	string	Identifier of the Dispute resource.
type Required	string	Type of the Dispute resource. The value is always dispute.
attributes Required	JSON Object	JSON object representing the Dispute data.
relationships Required	JSON:API Relationships	Describes relationships between the Dispute resource and other resources.

Attributes

Name	Type	Description
source Required	string	One of DebitCard or ACH
status Required	string	One of InvestigationStarted, ProvisionallyCredited, Denied, ResolvedLost, ResolvedWon.
statusHistory Required	Array of dispute statuses	A dispute status list with the status date. Possible statuses are InvestigationStarted, ProvisionallyCredited, Denied, ResolvedLost, ResolvedWon.
description Required	string	Dispute description.
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Optional	RFC3339 Date string	The date the resource was updated.
amount Required	string	The amount (cents) of the payment.
decisionReason Optional	string	Reason for a ResolvedLost status.
disputeType Optional	string	One of Issuer, Fraud, NonFraud.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account creating the payment.
customer Required	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.
transaction Required	JSON:API Relationship	The transaction the resource belongs to.
card Required	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:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always disputeTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account, customer, disputedTransaction).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
disputeId Required	string	Unique ID of the dispute that is related to the transaction.
summary Required	string	Summary of the transaction. Common to all transaction types.
reason Required	string	The reason for the dispute transaction, one of: ProvisionalCredit, ProvisionalCreditReversalDenied, ProvisionalCreditReversalResolved, FinalCredit.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account participating in the transaction.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
disputedTransaction Required	Optional, JSON:API Relationship	The transaction that has been disputed.

Example DisputeTransaction resource:

{
  "type": "disputeTransaction",
  "id": "226",
  "attributes": {
    "createdAt": "2021-04-19T12:44:08.055Z",
    "amount": 2500,
    "direction": "Credit",
    "balance": 550000,
    "summary": "Dispute 119 | Provisional Credit",
    "reason": "ProvisionalCredit"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "10001"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "10000"
      }
    },
    "disputedTransaction": {
      "data": {
        "type": "transaction",
        "id": "6"
      }
    }
  }
}

Event

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

Name	Type	Description
id Required	string	Identifier of the event resource.
type Required	string	Type of the event resource.
attributes Required	JSON Object	JSON object representing the event data, based on the event type. See Webhook Events.
relationships Required	JSON:API Relationships	Describes relationships between the event resource and other resources, based on the event type. See Webhook 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:

Name	Type	Description
id Required	string	Identifier of the application resource.
type Required	string	Type of the credit application resource. For existingCustomerCreditApplication the value is always existingCustomerCreditApplication.
attributes Required	JSON Object	JSON object representing the credit application data.
relationships Required	JSON:API Relationships	Describes relationships between the credit application resource and other resources.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
status Required	string	The status of the credit application. One of Created, Pending, Approved, Denied, Canceled.
aggregatorAccessTokens Optional	Array of string	Array of aggregator access tokens which are Plaid (or other account linking platform) integration tokens. See Plaid processor token
annualIncome Optional	Integer (Cents)	The annual income of the applicant.
numberOfEmployees Optional	NumberOfEmployees	Number of employees of the business.
yearsInBusiness Optional	Integer	Number of years the business has been in operation.
additionalUnderwritingData Optional	json	Object containing key-value pairs of underwriting data per credit policy.

Relationships

Name	Type	Description
customer Required	JSON:API Relationship	The Customer to which this credit application applies to.
lendingProgram Required	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:

Name	Type	Description
id Required	string	Identifier of the external repayment resource.
type Required	string	Type of the repayment resource. For external repayment the value is externalRepayment.
attributes Required	JSON Object	JSON object representing the repayment resource.
relationships Required	JSON:API Relationships	Describes relationships between the external repayment and the credit account.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Required	RFC3339 Date string	The date the resource was updated.
amount Required	integer	The amount (cents) of the repayment.
status Required	string	The status of the external repayment. One of Sent or Returned.
description Required	string	Repayment description.
tags Required	object	See Tags.

Relationships

Name	Type	Description
creditAccount Required	JSON:API Relationship	The Credit Account the repayment is made for.
org Required	JSON:API Relationship	The org the customer belongs to.
customer Required	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:

Name	Type	Description
id Required	string	Identifier of the fee resource.
type Required	string	Type of the fee resource. The value is always fee.
attributes Required	JSON Object	JSON object representing the fee data.
relationships Required	JSON:API Relationships	Describes relationships between the fee resource and other resources (accounts).

Attributes

Name	Type	Description
amount Required	integer	The amount (in cents) of the fee.
description Required	string	Description of the fee.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The account the fee belongs to.

Example Fee resource:

{
  "data": {
    "type": "fee",
    "id": "1234",
    "attributes": {
      "amount": 1000,
      "description": "Monthly Subscription"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "depositAccount",
          "id": "10097"
        }
      }
    }
  }
}

Fee Reversal Transaction

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

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always feeReversalTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account, customer and relatedTransaction).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
relatedTransaction Required	JSON:API Relationship	The fee transaction that the reversal is related to.

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:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always feeTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account, customer and relatedTransaction).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
relatedTransaction Optional	JSON:API Relationship	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:

Name	Type	Description
id Required	string	Identifier of the fee resource.
type Required	string	Type of the fee resource. The value is always feeReversal.
attributes Required	JSON Object	JSON object representing the fee data.
relationships Required	JSON:API Relationships	Describes relationships between the fee resource and other resources (accounts).

Attributes

Name	Type	Description
description Required	string	Description of the fee.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The account the fee belongs to.

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:

Name	Type	Description
id Required	string	Identifier of the deposit account resource.
type Required	string	Type of the resource, the value is always financialBusinessFBOAccount.
attributes Required	JSON Object	JSON object representing the financial business fbo account data.
relationships Required	JSON:API Relationships	Describes relationships between the financial business fbo account resource and the customer.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Optional	RFC3339 Date string	The date the resource was updated.
name Required	string	The official name.
depositProduct Required	string	The name of the deposit product.
routingNumber Required	string	Routing number of account.
accountNumber Required	string	Account number, together with the routingNumber forms the identifier of the account on the ACH network.
currency Required	string	Currency of the account.
balance Required	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 Required	integer	The hold amount (in cents). The hold represents funds that are not available for spending, due to an outstanding card authorization.
available Required	integer	The available balance for spending (in cents). Equals the balance minus the hold amount.
tags Required	object	See Tags.
status Required	string	Status of the account, either Open, Frozen, or Closed.
freezeReason Optional	string	The reason the account was frozen, either Fraud, ByBank, or free-text description.
closeReason Optional	string	The reason the account was closed, either ByCustomer or Fraud.
fraudReason Optional	string	The expanded fraud reason for closing the account when Fraud is specified as the reason. Can be one of: (ACHActivity, CardActivity, CheckActivity, ApplicationHistory, AccountActivity, ClientIdentified, IdentityTheft, LinkedToFraudulentCustomer).
dacaStatus Optional	string	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

Name	Type	Description
customer Required	JSON:API Relationship	The customer.

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:

Name	Type	Description
type Required	string	Type of the authorization request resource. The value is always pendingAuthorizationRequest.
id Required	string	The authorization request id
attributes Required	JSON Object	JSON object representing the authorization request data.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
available Required	integer	The available balance for spending (in cents).
status Required	string	The status of the request. will be always "Pending"
partialApprovalAllowed Required	boolean	Indicates whether the authorization request supports partial amount approval.
merchant.name Required	string	The name of the merchant.
merchant.type Required	integer	The 4-digit ISO 18245 merchant category code (MCC).
merchant.location Optional	string	The location (city, state, etc.) of the merchant.
merchant.id Optional	string	The unique network merchant identifier.
recurring Required	boolean	Indicates whether the authorization is recurring
direction Required	string	The direction in which the funds flow (either Debit or Credit).
mustBeApproved Required	boolean	Indicates whether the authorization request must be approved.
idempotencyKey Required	string	See Idempotency
tags Required	object	See Tags.
paymentMethod Optional	string	The payment method used, one of: Manual, Swipe, Contactless, ChipAndPin, Stored, Other.
ecommerce Optional	boolean	Indicates whether the transaction was created over an electronic network (primarily the internet).
cardPresent Optional	boolean	Indicates whether the card was present when the transaction was created.
healthcareAmounts Optional	Healthcare Amounts	IIAS related data for FSA/HRA enabled cards.
currencyConversion Optional	Currency Conversion	When original currency for transaction is not USD.
isInternational Optional	boolean	Indicates whether the transaction is international.
cardNetwork Optional	string	The network that this card is a part of, e.g. Visa, Interlink, etc.

Name	Type	Description
account Required	JSON:API Relationship	The account of the customer creating the atm transaction.
customer Required	JSON:API Relationship	The customer that created the atm transaction.
card Required	JSON:API Relationship	The debit card used in the transaction.
authorizationRequest Required	JSON:API Relationship	The authorization request.

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:

Name	Type	Description
id Required	string	Identifier of the application resource.
type Required	string	Type of the application resource. For individual application the value is always individualApplication.
attributes Required	JSON Object	JSON object representing the application data.
relationships Required	JSON:API Relationships	Describes relationships between the application resource and other resources (documents).

Attributes

Name	Type	Description
status Required	string	One of AwaitingDocuments, PendingReview, Approved, Denied or Pending, see Application Statuses.
message Required	string	A message describing the IndividualApplication status.
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Optional	RFC3339 Date string	The date the resource was updated.
ssn	string	SSN (or ITIN) of the individual (numbers only). Either an ssn or passport is required.
passport	string	Passport number of the individual. Valid only for non-US persons. Either an ssn or passport number is required.
nationality	ISO31661-Alpha2 string	Required if a passport is used as the main ID and optional when ssn is used. Two letters representing the individual's nationality. (e.g. "US").
fullName Required	FullName	Full name of the individual.
dateOfBirth Required	RFC3339 Date string	Date only (e.g. "2001-08-15").
address Required	Address	Address of the individual.
phone Required	Phone	Phone of the individual.
email Required	string	Email address of the individual.
ip Required	string	IP address of the end-customer creating the application, if specified.
soleProprietorship Optional	boolean	Indicates whether the individual is a sole proprietor, if specified.
ein Optional	string	Indicates if the individual is a sole proprietor who has an Employer Identification Number, if specified.
dba Optional	string	Indicates if the individual is a sole proprietor who is doing business under a different name, if specified.
occupation Optional	Occupation	Occupation of the individual.
annualIncome Optional	AnnualIncome	Annual income of the individual.
sourceOfIncome Optional	SourceOfIncome	Source of income of the individual.
annualRevenue Optional	AnnualRevenue	Indicates if the individual is a sole proprietor who has an Annual Revenue, if specified.
numberOfEmployees Optional	NumberOfEmployees	Indicates if the individual is a sole proprietor who has a Number Of Employees, if specified.
businessVertical Optional	BusinessVertical	Indicates if the individual is a sole proprietor who has a Business Vertical, if specified.
website Optional	string	Indicates if the individual is a sole proprietor who has a Business Website, if specified.
archived Required	boolean	Indicates whether the application has been archived. Archived applications are read-only and no changes can be made to them. Once an application has been archived, a new application with the same SSN (or Passport) may be submitted. An application becomes archived once the corresponding customer is archived.
idTheftScore Optional	number	Score (0-1000) for ID theft verification, >900 is auto rejected as default (threshold is configurable).
tags Required	object	See Tags.

Relationships

Name	Type	Description
documents Optional	Array of JSON:API Relationship	Application's documents.
customer Optional	JSON:API Relationship	The created Customer in case of approved application.
applicationForm Optional	JSON:API Relationship	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",
    "occupation": "ArchitectOrEngineer",
    "annualIncome": "Between50kAnd100k",
    "sourceOfIncome": "EmploymentOrPayrollIncome",
    "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:

Name	Type	Description
id Required	string	Identifier of the individual resource.
type Required	string	Type of the resource, the value is always individualCustomer.
attributes Required	JSON Object	JSON object representing the individual data.
relationships Required	JSON:API Relationships	Describes relationships between the customer resource, the Org it belongs to, and the Application it was created by.

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
ssn Required	string	Individual passport number. Either ssn or passport will be populated.
passport Required	string	Individual passport number. Either ssn or passport will be populated.
nationality	ISO31661-Alpha2 string	Required if a passport is used as the main ID and optional when ssn is used. Two letters representing the individual's nationality. (e.g. "US").
fullName Required	FullName	Full name of the individual.
dateOfBirth Required	RFC3339 Date string	Date only (e.g. "2001-08-15").
address Required	Address	Address of the individual.
phone Required	Phone	Phone of the individual.
email Required	string	Email address of the individual.
authorizedUsers Required	Array of AuthorizedUser	Array of authorized users. An authorized user is someone who can participate in the One Time Password (OTP) authentication process.
status Required	string	Status of the customer, either Active, Archived. You can't do any write operations with Archived customers.
eligibleProducts Optional	Array of Product	The products that the customer is eligible for.
ein Optional	string	Indicates if the individual is a sole proprietor who has an Employer Identification Number, if specified.
occupation Optional	Occupation	Occupation of the individual.
annualIncome Optional	AnnualIncome	Annual income of the individual.
sourceOfIncome Optional	SourceOfIncome	Source of income of the individual.
annualRevenue Optional	AnnualRevenue	Annual revenue if the customer is a sole proprietor.
numberOfEmployees Optional	NumberOfEmployees	Number of employees if the customer is a sole proprietor.
businessVertical Optional	BusinessVertical	Business vertical if the customer is a sole proprietor.
website Optional	string	Business's website if the customer is a sole proprietor.
archiveReason Optional	string	The reason the account was archived, can be one of ByBank, Inactive, FraudACHActivity, FraudCardActivity, FraudCheckActivity, FraudApplicationHistory, FraudAccountActivity, FraudClientIdentified, FraudLinkedToFraudulentCustomer.
tags Required	object	See Tags.

Relationships

Name	Type	Description
org Required	JSON:API Relationship	The Org of the individual.
application Required	JSON:API Relationship	The Application that created this individual.
authorizedUserResources Required	JSON:API Relationship	A list of the related AuthorizedUser.

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"
    },
    "occupation": "ArchitectOrEngineer",
    "annualIncome": "Between50kAnd100k",
    "sourceOfIncome": "EmploymentOrPayrollIncome",
    "annualRevenue": "Between100kAnd200k",
    "numberOfEmployees": "Between2And5",
    "businessVertical": "TechnologyMediaOrTelecom",
    "website": "https://piedpiper.com",
    "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:

Name	Type	Description
id Required	string	Identifier of the card resource.
type Required	string	Type of the card resource. For individual debit card the value is always individualDebitCard.
attributes Required	JSON Object	JSON object representing the card data.
relationships Required	JSON:API Relationships	Describes relationships between the card resource and other resources (account and customer).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Optional	RFC3339 Date string	The date the resource was updated.
last4Digits Required	string	Last 4 digits of the debit card.
expirationDate Required	string	Card expiration date, formatted YYYY-MM, e.g "2020-05".
shippingAddress Optional	Address	Shipping address, if specified.
bin Required	string	9-digit Bank Identification Number (BIN).
status Required	string	Status of the card, one of: Active, Inactive, Stolen, Lost, Frozen, ClosedByCustomer, SuspectedFraud.
design Optional	string	Card design, if specified.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The account the card belongs to.
customer Required	JSON:API Relationship	The individual or business customer the card belongs to.

Example IndividualDebitCard resource:

{
  "type": "individualDebitCard",
  "id": "8",
  "attributes": {
    "createdAt": "2020-05-13T09:07:47.645Z",
    "last4Digits": "1234",
    "expirationDate": "2022-05",
    "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:

Name	Type	Description
id Required	string	Identifier of the card resource.
type Required	string	Type of the card resource. For individual virtual debit card the value is always individualVirtualDebitCard.
attributes Required	JSON Object	JSON object representing the card data.
relationships Required	JSON:API Relationships	Describes relationships between the card resource and other resources (account and customer).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Optional	RFC3339 Date string	The date the resource was updated.
last4Digits Required	string	Last 4 digits of the debit card.
expirationDate Required	string	Card expiration date, formatted YYYY-MM, e.g "2020-05".
bin Required	string	9-digit Bank Identification Number (BIN).
status Required	string	Status of the card, one of: Active, Inactive, Stolen, Lost, Frozen, ClosedByCustomer, SuspectedFraud.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The account the card belongs to.
customer Required	JSON:API Relationship	The individual or business customer the card belongs to.

Example IndividualVirtualDebitCard resource:

{
  "type": "individualVirtualDebitCard",
  "id": "8",
  "attributes": {
    "createdAt": "2020-05-13T09:07:47.645Z",
    "last4Digits": "1234",
    "expirationDate": "2022-05",
    "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:

Name	Type	Description
type Required	string	Type of the institution resource. The value is always institution.
attributes Required	JSON Object	JSON object representing the institution data.

Attributes

Name	Type	Description
routingNumber Required	string	Routing number of the institution. Valid 9-digit ABA routing transit number.
name Required	string	Name of the institution.
address Optional	string	Address of the institution.
isACHSupported Required	boolean	Is FedACH participant.
isWireSupported Required	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:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always interestShareTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account, customer and org).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
org Required	JSON:API Relationship	The Org of the customer.

Example InterestShareTransaction resource:

{
  "data": {
    "type": "interestShareTransaction",
    "id": "12345",
    "attributes": {
      "createdAt": "2021-09-01T04:08:33.250Z",
      "amount": 1,
      "direction": "Credit",
      "balance": 7,
      "summary": "Interest Share August 2021"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "account",
          "id": "1"
        }
      },
      "customer": {
        "data": {
          "type": "customer",
          "id": "24"
        }
      },
      "customers": {
        "data": [
          {
            "type": "customer",
            "id": "24"
          }
        ]
      },
      "org": {
        "data": {
          "type": "org",
          "id": "1"
        }
      }
    }
  }
}

Interest Transaction

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

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always interestTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account and customer).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	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:

Name	Type	Description
type Required	string	Type of the lending program. The value is always bankSponsoredChargeCardProgram.
id Required	string	The lending program id
attributes Required	JSON Object	JSON object representing the lending program data.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
name Required	String	The name of the lending program
programSizeLimit Required	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:

Name	Type	Description
type Required	string	Type of the lending program. The value is always clientSponsoredChargeCardProgram.
id Required	string	The lending program id
attributes Required	JSON Object	JSON object representing the lending program data.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
name Required	String	The name of the lending program
programSizeLimit Required	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:

Name	Type	Description
type Required	string	Type of the lending program. The value is always receivablesRetentionProgram.
id Required	string	The lending program id
attributes Required	JSON Object	JSON object representing the lending program data.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
name Required	String	The name of the lending program
programSizeLimit Required	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:

Name	Type	Description
type Required	string	Type of the resource. The value is always lendingProgramExtendedInformation.
id Required	string	The lending program id
attributes Required	JSON Object	JSON object representing the lending program extended information data.

Attributes

Name	Type	Description
programSizeAvailable Required	Integer (Cents)	description
programSizeAllocated Required	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:

Name	Type	Description
type Required	string	Type of the MobileWalletPayload resource. The value is always mobileWalletPayload.
attributes Required	JSON Object	JSON object representing the MobileWalletPayload data.

Attributes

Name	Type	Description
payload Required	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:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always negativeBalanceCoverageTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account, customer and relatedTransaction).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	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:

Name	Type	Description
id Required	string	Identifier of the application resource.
type Required	string	Type of the credit application resource. For onboardingCreditApplication the value is always onboardingCustomerCreditApplication.
attributes Required	JSON Object	JSON object representing the credit application data.
relationships Required	JSON:API Relationships	Describes relationships between the credit application resource and other resources.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
status Required	string	The status of the credit application. One of Created, Pending, Approved, Denied, Canceled.
aggregatorAccessTokens Optional	Array of string	Array of aggregator access tokens which are Plaid (or other account linking platform) integration tokens. See Plaid processor token
annualIncome Optional	Integer (Cents)	The annual income of the applicant.
numberOfEmployees Optional	NumberOfEmployees	Number of employees of the business.
yearsInBusiness Optional	Integer	Number of years the business has been in operation.
additionalUnderwritingData Optional	json	Object containing key-value pairs of underwriting data per credit policy.

Relationships

Name	Type	Description
application Required	JSON:API Relationship	The Application to which this credit application applies to.
lendingProgram Required	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:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always originatedAchTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account and customer).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
description Required	string	Transaction description.
addenda	string	Optional, additional transaction description.
counterparty Required	Counterparty	The party on the other end of the transaction.
secCode Required	string	The 3-letter ACH Standard Entry Class (SEC) Code. One of WEB, CCD, PPD.
traceNumber Optional	string	The 15-digit ACH Trace Number identifies the transaction within the ACH file after transmission.
tags Required	object	See Tags. Inherited from the payment tags (see Tag Inheritance).

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
payment Required	JSON:API Relationship	The payment belonging to this transaction.
recurringPayment Required	Optional, JSON:API Relationship	The recurring payment belonging to this transaction.

Example OriginatedAchTransaction resource:

{
  "type": "originatedAchTransaction",
  "id": "1",
  "attributes": {
    "createdAt": "2020-09-06T07:51:02.570Z",
    "direction": "Credit",
    "amount": 10000,
    "balance": 10000,
    "summary": "Unit Inc | Initial account funding",
    "description": "Funding",
    "addenda": "Initial account funding",
    "counterparty": {
      "name": "Unit Inc",
      "routingNumber": "812345678",
      "accountNumber": "1",
      "accountType": "Checking"
    },
    "secCode": "WEB",
    "traceNumber": "812345670000123"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "10001"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "3"
      }
    },
    "payment": {
      "data": {
        "type": "payment",
        "id": "5"
      }
    }
  }
}

Payment Advance Transaction

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

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always paymentAdvanceTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account, customer, receivedPayment).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types. The value is always Debit.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account participating in the transaction.
customer Required	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 Required	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:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always paymentCanceledTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account, customer).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account participating in the transaction.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
org Required	JSON:API Relationship	The org the customer belongs to.
relatedTransaction Required	JSON:API Relationship	The original transaction being canceled.

Example PaymentCanceledTransaction resource:

{
  "type": "paymentCanceledTransaction",
  "id": "185",
  "attributes": {
    "createdAt": "2022-02-02T13:11:22.404Z",
    "amount": 7000,
    "direction": "Credit",
    "balance": 1702108,
    "summary": "Cancellation of: 184  |  Payment Id: 18"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "10002"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "10001"
      }
    },
    "customers": {
      "data": [
        {
          "type": "customer",
          "id": "10001"
        }
      ]
    },
    "relatedTransaction": {
      "data": {
        "type": "transaction",
        "id": "184"
      }
    }
  }
}

PinStatus

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

Name	Type	Description
type Required	string	Type of the PinStatus resource. The value is always pinStatus.
attributes Required	JSON Object	JSON object representing the PinStatus data.

Attributes

Name	Type	Description
status Required	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:

Name	Type	Description
id Required	string	Identifier of the purchase authorization request resource.
type Required	string	Type of the purchase authorization request resource. The value is always purchaseAuthorizationRequest.
attributes Required	JSON Object	JSON object representing the authorization request data.
relationships Required	JSON:API Relationships	Describes relationships between the authorization request resource and other resources (account, customer and card).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the authorization request was created.
amount Required	integer	The amount (cents) of the authorization request.
status Required	string	The status of the authorization request. Either Pending, Approved or Declined.
outcome Optional	string	What your programmatic integration produced when the request reached a terminal decision. See Understanding authorization decisions. One of Approved, Declined, PostTimeout, PostError, WaitTimeout.
partialApprovalAllowed Required	boolean	Indicates whether the authorization request supports partial amount approval.
approvedAmount Optional	integer	The amount (cents) that was approved. Available only when status is Approved.
declineReason Optional	string	The reason the authorization request was declined. One of AccountClosed, CardExceedsAmountLimit, DoNotHonor, InsufficientFunds, InvalidMerchant, ReferToCardIssuer, RestrictedCard, Timeout, TransactionNotPermittedToCardholder. Available only when status is Declined
merchant.name Required	string	The name of the merchant.
merchant.type Required	integer	The 4-digit ISO 18245 merchant category code (MCC).
merchant.category Required	string	The merchant category, described by the MCC code (see this reference for the list of category descriptions).
merchant.location Optional	string	The location (city, state, etc.) of the merchant.
merchant.id Optional	string	The unique network merchant identifier.
recurring Required	boolean	Indicates whether the authorization is recurring
ecommerce Optional	boolean	Indicates whether the transaction was created over an electronic network (primarily the internet).
cardPresent Optional	boolean	Indicates whether the card was present when the transaction was created.
paymentMethod Optional	string	The payment method used, one of: Manual, Swipe, Contactless, ChipAndPin, Stored, Other.
digitalWallet Optional	string	The type of digital wallet used, one of: Google, Apple, Other.
cardVerificationData. verificationMethod Optional	string	The verification method used, one of: Address, CVV2, AddressAndCVV2.
cardNetwork Optional	string	The card network used, one of: Visa, Interlink, Accel, Allpoint, Other.
healthcareAmounts Optional	Healthcare Amounts	IIAS related data for FSA/HRA enabled cards.
tags	object	Optional, See Tags. If specified when approving the authorization request.
cashWithdrawalAmount Optional	integer	Cash withdrawal amount
currencyConversion Optional	Currency Conversion	When original currency for transaction is not USD.
isInternational Optional	boolean	Indicates whether the transaction is international.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
card Required	JSON:API Relationship	The debit card used in the purchase.
fundingAccount Required	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": "Approved",
    "outcome": "Approved",
    "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:

Name	Type	Description
type Required	string	Type of the authorization request resource. The value is always pendingAuthorizationRequest.
id Required	string	The authorization request id
attributes Required	JSON Object	JSON object representing the authorization request data.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
available Required	integer	The available balance for spending (in cents).
status Required	string	The status of the request. will be always "Pending"
partialApprovalAllowed Required	boolean	Indicates whether the authorization request supports partial amount approval.
merchant.name Required	string	The name of the merchant.
merchant.type Required	integer	The 4-digit ISO 18245 merchant category code (MCC).
merchant.location Optional	string	The location (city, state, etc.) of the merchant.
merchant.id Optional	string	The unique network merchant identifier.
recurring Required	boolean	Indicates whether the authorization is recurring
direction Required	string	The direction in which the funds flow (either Debit or Credit).
mustBeApproved Required	boolean	Indicates whether the authorization request must be approved.
idempotencyKey Required	string	See Idempotency
tags Required	object	See Tags.
paymentMethod Optional	string	The payment method used, one of: Manual, Swipe, Contactless, ChipAndPin, Stored, Other.
ecommerce Optional	boolean	Indicates whether the transaction was created over an electronic network (primarily the internet).
cardPresent Optional	boolean	Indicates whether the card was present when the transaction was created.
currencyConversion Optional	Currency Conversion	When original currency for transaction is not USD.
isInternational Optional	boolean	Indicates whether the transaction is international.
cardNetwork Optional	string	The network that this card is a part of, e.g. Visa, Interlink, etc.

Name	Type	Description
account Required	JSON:API Relationship	The account of the customer creating the atm transaction.
customer Required	JSON:API Relationship	The customer that created the atm transaction.
card Required	JSON:API Relationship	The debit card used in the transaction.
authorizationRequest Required	JSON:API Relationship	The authorization request.

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:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always purchaseTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account and customer).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
cardLast4Digits Required	string	The last 4 digits of the debit card involved in the transaction.
merchant.name Required	string	The name of the merchant.
merchant.type Required	integer	The 4-digit ISO 18245 merchant category code (MCC).
merchant.category Required	string	The merchant category, described by the MCC code (see this reference for the list of category descriptions).
merchant.location Optional	string	The location (city, state, etc.) of the merchant.
merchant.id Optional	string	The unique network merchant identifier.
coordinates Optional	Coordinates	Coordinates (latitude, longitude) of where the purchase took place.
recurring Required	boolean	Indicates whether the transaction is recurring.
interchange Optional	string	The interchange share for this transaction. Calculated at the end of each day, see the transaction.updated event.
grossInterchange Optional	string	The gross interchange share for this transaction.
ecommerce Required	boolean	Indicates whether the transaction was created over an electronic network (primarily the internet).
cardPresent Required	boolean	Indicates whether the card was present when the transaction was created.
paymentMethod Optional	string	The payment method used, one of: Manual, Swipe, Contactless, ChipAndPin, Stored, Other.
digitalWallet Optional	string	The type of digital wallet used, one of: Google, Apple, Other.
cardVerificationData.verificationMethod Optional	string	The verification method used, one of: Address, CVV2, AddressAndCVV2.
cardNetwork Optional	string	The card network used, one of: Visa, Interlink, Accel, Allpoint, Other.
tags Required	object	See Tags. Inherited from the authorization request tags (see Tag Inheritance).
cashWithdrawalAmount Optional	integer	Cash withdrawal amount
richMerchantData Optional	Rich Merchant Data	Full merchant information. See Transaction Enrichment.
currencyConversion Optional	Currency Conversion	When original currency for transaction is not USD.
cardDecisionSource Optional	string	Who made the final card authorization decision. See Understanding authorization decisions. One of Org, Unit, Network, TimeoutApprove, TimeoutDecline, DefaultApprove, InternalError, IssuerStandIn.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
card Required	JSON:API Relationship	The debit card involved in the transaction.
authorization Optional	JSON:API Relationship	The Authorization request made by the merchant, if present (see Authorizations).
authorizationRequest Required	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",
    "cardDecisionSource": "Org"
  },
  "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:

Name	Type	Description
id Required	string	Identifier of the push-to-card payment resource.
type Required	string	Type of the payment resource. The value is always pushToCardPayment.
attributes Required	JSON Object	JSON object representing the payment resource.
relationships Required	JSON:API Relationships	Describes relationships between the push-to-card payment resource and other resources .

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
status Required	string	Either Pending, Sent or Rejected (see reason for details).
reason Optional	string	More information about the status.
description Required	string	Payment description.
amount Required	string	The amount (cents) of the payment.
tags Required	object	See Tags.
astraRoutineId Optional	string	In case the payment status is Sent it is the generated astra routine id

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account creating the payment.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to a multiple individual customers.
transaction Required	JSON:API Relationship	The PushToCard Transaction generated by this payment.
achPayment Required	JSON:API Relationship	The ACH Payment generated by this payment.

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:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always pushToCardReversalTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
tags Required	object	See Tags. Inherited from the payment tags (see Tag Inheritance).

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
payment Required	Optional, JSON:API Relationship	The payment belonging to this transaction.
org Required	JSON:API Relationship	The org the customer belongs to.
originalTransaction Required	JSON:API Relationship	The original push to card transaction

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:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always pushToCardTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
tags Required	object	See Tags. Inherited from the payment tags (see Tag Inheritance).

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
payment Required	Optional, JSON:API Relationship	The payment belonging to this transaction.
org Required	JSON:API Relationship	The org the customer belongs to.

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:

Name	Type	Description
type Required	string	Type of the receivable. The value can be one of the following bankReceivable, orgReceivable, capitalPartnerReceivable.
id Required	string	The receivable id
attributes Required	JSON Object	JSON object representing the receivable data.
relationships Required	JSON:API Relationships	Describes relationships between the receivable resource and other resources.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Required	RFC3339 Date string	The date the resource was updated.
originalAmount Required	Integer (Cents)	The original amount of the receivable that need to be repaid.
remainingAmount Required	Integer (Cents)	The remaining amount of the receivable that need to be repaid.
repaymentStatus Required	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.
purchaseDueDate Optional	String	The date the receivable is due e.g. 2024-12-31.
purchasedTimestamp Optional	RFC3339 Date string	The date the receivable was purchased
capitalPartnerId Optional	String	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:

Name	Type	Description
type Required	string	The type will be always receivablesBalance.
attributes Required	JSON Object	JSON object representing the receivable data.

Attributes

Name	Type	Description
pendingPurchaseReceivablesAmount Required	Integer (Cents)	The remaining amount to be purchased.
purchaseDueDate Optional	String	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:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always receivedAchTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account and customer).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
description Required	string	Transaction description.
addenda Optional	string	Additional transaction description (maximum of 50 characters).
companyName Required	string	The name by which the originator is known to the receiver.
counterpartyRoutingNumber Required	string	The routing number of the party that originated the ACH payment.
traceNumber Required	string	The ACH Trace Number.
secCode Optional	string	The 3-letter ACH Standard Entry Class (SEC) Code (e.g. WEB, CCD, PPD, etc.).
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	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:

Name	Type	Description
id Required	string	Identifier of the recurring ACH repayment resource.
type Required	string	Type of the recurring repayment resource. For recurring ach repayment the value is recurringAchRepayment.
attributes Required	JSON Object	JSON object representing the recurring repayment resource.
relationships Required	JSON:API Relationships	Describes relationships between the Recurring ACH repayment and the originating deposit account, counterparty, credit account, customer and org.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Required	RFC3339 Date string	The date the resource was updated.
schedule Required	Schedule	The schedule of the recurring payment.
description Required	string	Repayment description (maximum of 50 characters). this will show up on the statement of the counterparty.
addenda	string	Optional, additional payment description (maximum of 80 characters), not all institutions present that.
sameDay	boolean	Optional, default is false. See Same Day ACH.
secCode Optional	string	See Use a custom SEC Code.
tags Optional	object	See Tags. Tags that will be copied to any transaction that this payment creates (see Tag Inheritance).
numberOfRepayments Required	integer	Represents the number of repayments that were created by this recurring payment.
status Required	string	Status of the recurring repayment, one of: Active, Disabled.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account originating the repayment.
creditAccount Required	JSON:API Relationship	The Credit Account the repayment is made for.
counterparty Required	JSON:API Relationship	The Counterparty the repayment to be made from.
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.
org Required	JSON:API Relationship	The org the customer belongs to.

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:

Name	Type	Description
id Required	string	Identifier of the recurring Book repayment resource.
type Required	string	Type of the recurring repayment resource. For recurring book repayment the value is recurringBookRepayment.
attributes Required	JSON Object	JSON object representing the recurring repayment resource.
relationships Required	JSON:API Relationships	Describes relationships between the Recurring Book repayment and the originating deposit account, counterpartyAccount, credit account, customer and org.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Required	RFC3339 Date string	The date the resource was updated.
schedule Required	Schedule	The schedule of the recurring payment.
description Required	string	Repayment description (maximum of 80 characters). this will show up on the statement of the counterparty.
transactionSummaryOverride Required	string	If this field is populated, its contents will be returned as the bookTransaction's summary field (maximum of 100 characters).
tags Optional	object	See Tags. Tags that will be copied to any transaction that this payment creates (see Tag Inheritance).
numberOfRepayments Required	integer	Represents the number of repayments that were created by this recurring payment.
status Required	string	Status of the recurring repayment, one of: Active, Disabled.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account originating the repayment.
creditAccount Required	JSON:API Relationship	The Credit Account the repayment is made for.
counterparty Required	JSON:API Relationship	The Counterparty the repayment to be made from.
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.
org Required	JSON:API Relationship	The org the customer belongs to.

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:

Name	Type	Description
id Required	string	Identifier of the recurring ACH repayment resource.
type Required	string	Type of the recurring repayment resource. For recurring capital partner ach repayment the value is recurringCapitalPartnerAchRepayment.
attributes Required	JSON Object	JSON object representing the recurring repayment resource.
relationships Required	JSON:API Relationships	Describes relationships between the Recurring Repayment and the counterparty, credit account, customer and org.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Required	RFC3339 Date string	The date the resource was updated.
schedule Required	Schedule	The schedule of the recurring payment.
description Required	string	Repayment description (maximum of 50 characters). this will show up on the statement of the counterparty.
addenda	string	Optional, additional payment description (maximum of 80 characters), not all institutions present that.
sameDay	boolean	Optional, default is false. See Same Day ACH.
secCode Optional	string	See Use a custom SEC Code.
tags Optional	object	See Tags. Tags that will be copied to any transaction that this payment creates (see Tag Inheritance).
numberOfRepayments Required	integer	Represents the number of repayments that were created by this recurring payment.
status Required	string	Status of the recurring repayment, one of: Active, Disabled.

Relationships

Name	Type	Description
creditAccount Required	JSON:API Relationship	The Credit Account the repayment is made for.
counterparty Required	JSON:API Relationship	The Counterparty the repayment to be made from.
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.
org Required	JSON:API Relationship	The org the customer belongs to.

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:

Name	Type	Description
id Required	string	Identifier of the recurring capital partner Book repayment resource.
type Required	string	Type of the recurring repayment resource. For recurring capital partner book repayment the value is recurringCapitalPartnerBookRepayment.
attributes Required	JSON Object	JSON object representing the recurring repayment resource.
relationships Required	JSON:API Relationships	Describes relationships between the Recurring repayment and the counterpartyAccount, credit account, customer and org.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Required	RFC3339 Date string	The date the resource was updated.
schedule Required	Schedule	The schedule of the recurring payment.
description Required	string	Repayment description (maximum of 50 characters). this will show up on the statement of the counterparty.
transactionSummaryOverride Required	string	If this field is populated, its contents will be returned as the bookTransaction's summary field (maximum of 100 characters).
tags Optional	object	See Tags. Tags that will be copied to any transaction that this payment creates (see Tag Inheritance).
numberOfRepayments Required	integer	Represents the number of repayments that were created by this recurring payment.
status Required	string	Status of the recurring repayment, one of: Active, Disabled.

Relationships

Name	Type	Description
creditAccount Required	JSON:API Relationship	The Credit Account the repayment is made for.
counterparty Required	JSON:API Relationship	The Counterparty the repayment to be made from.
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.
org Required	JSON:API Relationship	The org the customer belongs to.

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:

Name	Type	Description
id Required	string	Identifier of the recurring Credit ACH payment resource.
type Required	string	Type of the payment resource. For credit ach recurring payments the value is recurringCreditAchPayment.
attributes Required	JSON Object	JSON object representing the recurring payment resource.
relationships Required	JSON:API Relationships	Describes relationships between the Recurring Credit ACH payment and the originating deposit account and org.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Required	RFC3339 Date string	The date the resource was updated.
amount Required	integer	The amount (cents) of the payment.
description Required	string	Payment description (maximum of 10 characters), also known as Company Entry Description, this will show up on statement of the counterparty.
addenda	string	Optional, additional payment description (maximum of 80 characters), not all institutions present that.
status Required	string	Status of the recurring payment, one of: Active, Completed, Disabled, Deleted.
numberOfPayments Required	integer	Represents the number of payments that were created by this recurring payment.
schedule Required	Schedule	The schedule of the recurring payment.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account originating the recurring payment.
org Required	JSON:API Relationship	The org the customer belongs to.
customer Required	Optional, JSON:API Relationship	The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
counterparty Required	JSON:API Relationship	The Counterparty the payment to be made to.

Example RecurringCreditAchPayment resource:

{
  "data": {
    "type": "recurringCreditAchPayment",
    "id": "1",
    "attributes": {
      "createdAt": "2022-06-25T08:50:49.391Z",
      "updatedAt": "2022-06-25T08:50:49.391Z",
      "amount": 1000,
      "description": "Rent - Apartment 15",
      "schedule": {
        "startTime": "2022-06-25",
        "interval": "Monthly",
        "nextScheduledAction": "2022-07-18",
        "dayOfMonth": 16
      },
      "status": "Active",
      "numberOfPayments": 0
    },
    "relationships": {
      "counterparty": {
        "data": {
          "type": "counterparty",
          "id": "1"
        }
      },
      "account": {
        "data": {
          "type": "account",
          "id": "10002"
        }
      },
      "customer": {
        "data": {
          "type": "customer",
          "id": "10004"
        }
      },
      "org": {
        "data": {
          "type": "org",
          "id": "1"
        }
      }
    }
  }
}

Recurring Credit Book Payment

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

Name	Type	Description
id Required	string	Identifier of the recurring credit book payment resource.
type Required	string	Type of the payment resource. The value is always recurringCreditBookPayment.
attributes Required	JSON Object	JSON object representing the payment resource.
relationships Required	JSON:API Relationships	Describes relationships between the recurring credit book payment and the originating deposit account and org.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Required	RFC3339 Date string	The date the resource was updated.
amount Required	string	The amount (cents) of the payment.
description Required	string	Payment description (maximum of 80 characters), this will show up on statement of the counterparty.
status Required	string	Status of the recurring payment, one of: Active, Completed, Disabled, Deleted.
numberOfPayments Required	integer	Represents the number of payments that were created by this recurring payment.
schedule Required	Schedule	The schedule of the recurring payment.
transactionSummaryOverride Required	string	If this field is populated, its contents will be returned as the bookTransaction's summary field (maximum of 100 characters).
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account creating the recurring payment.
counterpartyAccount Required	JSON:API Relationship	The Counterparty account the payment to be made to.
org Required	JSON:API Relationship	The org the customer belongs to.
customer Required	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:

Name	Type	Description
id Required	string	Identifier of the recurring Credit ACH payment resource.
type Required	string	Type of the payment resource. For credit ach recurring payments the value is recurringCreditAchPayment.
attributes Required	JSON Object	JSON object representing the recurring payment resource.
relationships Required	JSON:API Relationships	Describes relationships between the Recurring Credit ACH payment and the originating deposit account and org.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Required	RFC3339 Date string	The date the resource was updated.
amount Required	integer	The amount (cents) of the payment.
description Required	string	Payment description (maximum of 10 characters), also known as Company Entry Description, this will show up on statement of the counterparty.
addenda	string	Optional, additional payment description (maximum of 80 characters), not all institutions present that.
status Required	string	Status of the recurring payment, one of: Active, Completed, Disabled, Deleted.
numberOfPayments Required	integer	Represents the number of payments that were created by this recurring payment.
schedule Required	Schedule	The schedule of the recurring payment.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account originating the recurring payment.
org Required	JSON:API Relationship	The org the customer belongs to.
customer Required	Optional, JSON:API Relationship	The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
counterparty Required	JSON:API Relationship	The Counterparty the payment to be made to.

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:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always releaseTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
senderName Required	string	Name of the sender.
senderAddress Required	Address	Address of the sender.
senderAccountNumber Required	string	Unique identifier to monitor for similar sending accounts, could be the BIN + last four digits of the card number OR a unique identifier generated by you for the sender.
counterparty Required	Counterparty	The party who is releasing the funds
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types. The value is always Credit.
description Required	string	Description of the payment.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account receiving the funds.

Example ReleaseTransaction resource:

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

Repaid Payment Advance Transaction

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

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always repaidPaymentAdvanceTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account, customer, related transaction, receivedPayment).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types. The value is always Credit.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account participating in the transaction.
customer Required	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 Required	JSON:API Relationship	The ReceivedPayment that was previously advanced and now completed (and repaid) .
paymentAdvanceTransaction Required	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:

Name	Type	Description
ids Required	Array	Array of resource identifiers.
type Required	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:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always returnedAchTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account and customer).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
companyName Required	string	The name by which the originator is known to the receiver.
counterpartyName Required	string	The name of the party that originated the ACH payment.
counterpartyRoutingNumber Required	string	The routing number of the party that originated the ACH payment.
reason Required	string	The reason for the transaction return. See ACH return reasons.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
payment Required	JSON:API Relationship	The returned payment.

Example ReturnedAchTransaction resource:

{
  "type": "returnedAchTransaction",
  "id": "4",
  "attributes": {
    "createdAt": "2020-09-08T12:41:43.360Z",
    "direction": "Debit",
    "amount": 1000,
    "balance": 9000,
    "summary": "Return due to: NoAccount | Counterparty: Unit Inc",
    "companyName": "Unit Inc",
    "counterpartyName": "Unit Inc",
    "counterpartyRoutingNumber": "812345678",
    "reason": "NoAccount"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "1"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "3"
      }
    },
    "payment": {
      "data": {
        "type": "payment",
        "id": "1"
      }
    }
  }
}

Returned Check Deposit Transaction

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

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always returnedCheckDepositTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account, customer, checkDeposit).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
reason Required	string	The reason for the transaction return.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account participating in the transaction.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
checkDeposit Required	JSON:API Relationship	The Check Deposit the transaction is related to.

Example ReturnedCheckDepositTransaction resource:

{
  "data": {
    "type": "returnedCheckDepositTransaction",
    "id": "265",
    "attributes": {
      "createdAt": "2021-06-06T07:23:30.101Z",
      "amount": 200,
      "direction": "Debit",
      "balance": 3716500,
      "summary": "Returned due to: Insufficient Funds  |  Check deposit",
      "reason": "Insufficient Funds"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "account",
          "id": "10001"
        }
      },
      "customer": {
        "data": {
          "type": "customer",
          "id": "10000"
        }
      },
      "checkDeposit": {
        "data": {
          "type": "checkDeposit",
          "id": "122"
        }
      }
    }
  }
}

Returned Check Payment Transaction

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

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always returnedCheckPaymentTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account, customer, checkPayment).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
returnReason Required	string	The reason for the transaction return. This is a replacement to the deprecated reason attribute.
tags Required	object	See Tags.

Note

Currently, bot reason and returnReason are supported. Be advised that the values they return are different and that returnReason will soon be deprecated, and reason will be used to return the check payment return reasons as specified in the return reasons list.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account participating in the transaction.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
checkPayment Required	JSON:API Relationship	The Check Payment the transaction is related to.

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:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always returnedReceivedAchTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account and customer).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
companyName Required	string	The name by which the originator is known to the receiver.
reason Required	string	The reason for the transaction return. See ACH return reasons.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
returned Required	JSON:API Relationship	The returned transaction.

Example ReturnedReceivedAchTransaction resource:

{
  "type": "returnedReceivedAchTransaction",
  "id": "4",
  "attributes": {
    "createdAt": "2020-09-08T12:41:43.360Z",
    "direction": "Debit",
    "amount": 1000,
    "balance": 500,
    "summary": "Returned received ACH transaction #55 due to: Account has insufficient funds",
    "companyName": "John Doe",
    "reason": "InsufficientFunds"
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "1"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "3"
      }
    },
    "returned": {
      "data": {
        "type": "transaction",
        "id": "55"
      }
    }
  }
}

Returned Wire Transaction

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

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always returnedWireTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account and customer).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
reason Required	string	The reason for the return.
imad Required	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.
omad Optional	string	Output Message Accountability Data. It's a unique number given to each FedWire payment in case of payment has been sent and fully processed.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
payment Required	JSON:API Relationship	The wire payment that was returned

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:

Name	Type	Description
id Required	string	Identifier of the reward resource.
type Required	string	Type of the reward resource. The value is always reward.
attributes Required	JSON Object	JSON object representing the reward data.
relationships Required	JSON:API Relationships	Describes relationships between the reward resource and other resources (accounts, transaction, customer).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the reward was created.
amount Required	integer	The amount (in cents) of the reward.
description Required	string	Description of the reward.
status Required	string	Either Sent or Rejected (see rejectReason for details).
rejectReason Optional	string	More information about the status.
tags Required	object	See Tags.

Relationships

Name	Type	Description
receivingAccount Required	JSON:API Relationship	The account that received the funds.
fundingAccount Required	JSON:API Relationship	The account that sent the funds.
rewardedTransaction Optional	JSON:API Relationship	The transaction that caused the reward.
customer Required	JSON:API Relationship	The Customer the deposit account belongs to.
transaction Required	JSON:API Relationship	The Reward Transaction generated by the reward.
card Optional	JSON:API Relationship	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:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always rewardTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (accounts, customer, reward).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types, this will be the description of the reward.
receiverCounterparty Optional	Counterparty	The receiving party of the transaction. Available only when the receiving party is a Deposit Account.
tags Required	object	See Tags. Inherited from the payment tags (see Tag Inheritance).

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
reward Required	JSON:API Relationship	The reward belonging to this transaction.
receiverAccount Required	JSON:API Relationship	The Deposit Account receiver.

Example RewardTransaction resource:

{
  "data": {
    "type": "rewardTransaction",
    "id": "51",
    "attributes": {
      "createdAt": "2022-04-05T10:46:34.371Z",
      "receiverCounterparty": {
        "name": "Unit Finance Inc.",
        "routingNumber": "091311229",
        "accountNumber": "864800000000",
        "accountType": "Checking"
      },
      "amount": 800,
      "direction": "Credit",
      "balance": 113000,
      "summary": "My Reward 8",
      "tags": {
        "customer_type": "vip"
      }
    },
    "relationships": {
      "account": {
        "data": {
          "type": "account",
          "id": "10001"
        }
      },
      "customer": {
        "data": {
          "type": "customer",
          "id": "10000"
        }
      },
      "customers": {
        "data": [
          {
            "type": "customer",
            "id": "10000"
          }
        ]
      },
      "org": {
        "data": {
          "type": "org",
          "id": "1"
        }
      },
      "reward": {
        "data": {
          "type": "reward",
          "id": "1"
        }
      },
      "receiverAccount": {
        "data": {
          "type": "account",
          "id": "10000"
        }
      }
    }
  }
}

Statement

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

Name	Type	Description
id Required	string	Identifier of the statement resource.
type Required	string	Type of the statement resource. The value is always statement.
attributes Required	JSON Object	JSON object representing the statement data.
relationships Required	JSON:API Relationships	Describes relationships between the statement resource and other resources (account and customer).

Attributes

Name	Type	Description
period Required	string	Period of the statement, formatted YYYY-MM, e.g "2020-05".

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The account to which the statement was produced.
customer Required	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 Required	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:

Name	Type	Description
type Required	string	Type of the Store Location resource. The value is always storeLocation.
attributes Required	JSON Object	JSON object representing the Store Location data.

Attributes

Name	Type	Description
storeId Required	string	Identifier of the retail store that supports Cash Deposits. This field will be used as storeId when Creating a Cash Deposit Barcode.
retailerName Required	string	Name of the retail store that supports Cash Deposits.
phone Required	Phone	Phone of the retail store.
address Required	Address	Address of the retail store.
coordinates Required	Coordinates	Coordinates (latitude, longitude) of the retail store.
distance Required	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:

Name	Type	Description
id Required	string	Identifier of the tax form resource.
type Required	string	Type of the tax form resource.
attributes Required	JSON Object	JSON object representing the statement data.
relationships Required	JSON:API Relationships	Describes relationships between the tax form resource and other resources (account and customer).

Attributes

Name	Type	Description
formType Required	string	the type of the tax form.
taxYear Required	ISO8601 Year string	The tax year of the form, formatted YYYY, e.g "2020".

Relationships

Name	Type	Description
account Required	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 Required	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.
customer Required	JSON:API Relationship	The Customer the deposit account belongs to.

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:

Name	Type	Description
id Required	string	Identifier of the transaction card fraud case resource.
type Required	string	Type of the transaction card fraud case resource. The value is always transactionCardFraudCase
attributes Required	JSON Object	JSON object representing the transaction card fraud case data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction card fraud case resource and other resources.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
status Required	string	The status of the card fraud case. Can be one of Created, Active, Closed, Expired.
decision Required	string	The decision made for the card fraud case. Can be one of Pending, Fraud, NoFraud.
expiresAt Required	RFC3339 Date string	The date the card fraud case expires.
cardActivities Required	Array of Fraud Case Card Activity	The card activities associated with the card fraud case.
updatedAt Optional	RFC3339 Date string	The date the resource was last updated.

Relationships

Name	Type	Description
card Required	JSON:API Relationship	The Card the fraud case is related to.
account Required	JSON:API Relationship	The Account the card belongs to.
customer Required	JSON:API Relationship	The individual or business Customer the card belongs to.
transaction Required	JSON:API Relationship	The primary Transaction card activity of the card fraud case.

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:

Name	Type	Description
id Required	string	Identifier of the wallet account resource.
type Required	string	Type of the resource, the value is always walletAccount.
attributes Required	JSON Object	JSON object representing the wallet account data.
relationships Required	JSON:API Relationships	Describes relationships between the wallet account resource and the customer.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
name Required	string	The official name.
status Required	string	Status of the account, either Open, Frozen, or Closed.
walletTerms Required	string	The name of the wallet terms.
routingNumber Required	string	Routing number of wallet.
accountNumber Required	string	Account number, together with the routingNumber forms the identifier of the wallet on the ACH network.
currency Required	string	Currency of the wallet.
balance Required	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 Required	integer	The hold amount (in cents). The hold represents funds that are not available for spending, due to an outstanding card authorization.
available Required	integer	The available balance for spending (in cents). Equals the balance minus the hold amount.
tags Required	object	See Tags.
freezeReason Optional	string	The reason the wallet was frozen, either Fraud, ByBank, or free-text description.
closeReason Optional	string	The reason the wallet was closed, either ByCustomer or Fraud.
fraudReason Optional	string	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

Name	Type	Description
customer Required	JSON:API Relationship	The customer.

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:

Name	Type	Description
id Required	string	Identifier of the webhook resource.
type Required	string	Type of the webhook resource. The value is always webhook.
attributes Required	JSON Object	JSON object representing the webhook data.

Attributes

Name	Type	Description
createdAt Required	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:

Name	Type	Description
id Required	string	Identifier of the white-label application form resource.
type Required	string	Type of the application form resource. The value is always applicationFormV2.
attributes Required	JSON Object	JSON object representing the white-label application form data.
links Required	object	Related Link object with url to be used in component.
relationships Required	JSON:API Relationships	Describes relationships between the white-label application form resource and other resources

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
updatedAt Required	RFC3339 Date string	The date the resource was updated.
tags Required	object	See Tags. Tags that will be copied to the application that this form creates (see Tag Inheritance).
applicationFormToken Required	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 Required	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 Required	ApplicationFormSettingsOverride	Disclosure URLs that will override the ones that were defined in the application form settings.
url Required	string	The URL of the application form for the end-customer to access

Relationships

Name	Type	Description
application Required	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:

Name	Type	Description
id Required	string	Identifier of the Positive Pay rule.
type Required	string	Type of the resource. The value is always receivedAchDebitPositivePay.
attributes Required	JSON Object	JSON object representing the Positive Pay rule data.
relationships Required	JSON:API Relationships	Describes relationships between the Positive Pay rule and other resources.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
status Required	string	One of Active, Expired, or Cancelled.
originatorName Required	string	Name of the ACH debit originator.
originatorEntityId Required	string	Entity ID of the ACH debit originator.
amount Required	integer	Maximum allowed debit amount in cents.
expirationDate Optional	RFC3339 Date	When the authorization expires.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The account this Positive Pay rule applies to.

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:

Name	Type	Description
id Required	string	Identifier of the Positive Pay rule.
type Required	string	Type of the resource. The value is always receivedAchCreditPositivePay.
attributes Required	JSON Object	JSON object representing the Positive Pay rule data.
relationships Required	JSON:API Relationships	Describes relationships between the Positive Pay rule and other resources.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
status Required	string	One of Active, Expired, or Cancelled.
originatorName Required	string	Name of the ACH credit originator.
originatorEntityId Required	string	Entity ID of the ACH credit originator.
amount Required	integer	Maximum allowed credit amount in cents.
expirationDate Optional	RFC3339 Date	When the authorization expires.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The account this Positive Pay rule applies to.

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:

Name	Type	Description
id Required	string	Identifier of the Positive Pay rule.
type Required	string	Type of the resource. The value is always checkPaymentPositivePay.
attributes Required	JSON Object	JSON object representing the Positive Pay rule data.
relationships Required	JSON:API Relationships	Describes relationships between the Positive Pay rule and other resources.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
status Required	string	One of Active, Expired, or Cancelled.
checkNumber Required	string	Check number to authorize.
payeeName Optional	string	Payee name to add specificity.
amount Required	integer	Expected amount in cents.
expirationDate Optional	RFC3339 Date	When the authorization expires.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The account this Positive Pay rule applies to.

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:

Name	Type	Description
id Required	string	Identifier of the Positive Pay rule.
type Required	string	Type of the resource. The value is always drawdownPositivePay.
attributes Required	JSON Object	JSON object representing the Positive Pay rule data.
relationships Required	JSON:API Relationships	Describes relationships between the Positive Pay rule and other resources.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
status Required	string	One of AwaitingDocuments, Active, Expired, or Cancelled.
expirationDate Optional	RFC3339 Date	When the authorization expires.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The account this Positive Pay rule applies to.

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:

Name	Type	Description
id Required	string	Identifier of the wire drawdown resource.
type Required	string	Type of the resource, the value is always wire-drawdown.
attributes Required	JSON Object	JSON object representing the wire drawdown data.
relationships Required	JSON:API Relationships	Describes relationships between the wire-drawdown resource and other resources.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
amount Required	integer	The amount (cents) of the wire drawdown.
description Required	string	Wire drawdown description.
counterparty Required	Wire Counterparty	The beneficiary party on the other end of the wire drawdown.
direction Required	string	The direction of the wire drawdown, either Incoming or Outgoing.
imad Required	string	Input Message Accountability Data. It's a unique number given to each wire drawdown.
omad Required	string	Output Message Accountability Data. It's a unique number given to each wire drawdown.
senderReference Required	string	Sender reference.
referenceForBeneficiary Required	string	Reference for the Beneficiary.
beneficiaryInformation Required	string	Beneficiary Information, multi-line string delimited by \n.
beneficiaryAdviceInformation Required	string	Beneficiary Advice Information, multi-line string delimited by \n.
originatorToBeneficiaryInformation Required	string	Originator To Beneficiary Information, multi-line string delimited by \n.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Account the wire drawdown belongs to.
customer Required	JSON:API Relationship	The Customer the wire drawdown belongs to.
drawdownPayment Required	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:

Name	Type	Description
id Required	string	Identifier of the wire payment resource.
type Required	string	Type of the payment resource. The value is always wirePayment.
attributes Required	JSON Object	JSON object representing the payment resource.
relationships Required	JSON:API Relationships	Describes relationships between the Wire payment and the originating deposit account, customer and transaction.

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the resource was created.
status Required	string	Either Pending, Returned, Sent , Canceled or Rejected (see reason for details).
reason Optional	string	More information about the status.
direction Required	string	The direction in which the funds flow (Credit only).
description Required	string	Payment description (maximum of 50 characters), this will show up on statement of the counterparty.
counterparty Required	Wire Counterparty	The beneficiary party on the other end of the payment.
amount Required	string	The amount (cents) of the payment.
tags Required	object	See Tags.
imadOmad Required	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

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account creating the payment.
customer Required	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 Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to a multiple individual customers.
transaction Required	JSON:API Relationship	The Wire Transaction generated by this payment.
wireDrawdown Required	Optional, JSON:API Relationship	In case of drawdown payment, the related Wire Drawdown.

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:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always wireTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account and customer).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
imadOmad Required	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 Required	Counterparty	The party on the other end of the transaction, either the beneficiary or the originator.
description Optional	string	Description of the transaction as entered by the originator.
originatorToBeneficiaryInformation Required	string	Originator To Beneficiary Information, multi-line string delimited by \n.
senderReference Required	string	Sender reference.
referenceForBeneficiary Required	string	Reference for the Beneficiary.
beneficiaryInformation Required	string	Beneficiary Information, multi-line string delimited by \n.
beneficiaryAdviceInformation Required	string	Beneficiary Advice Information, multi-line string delimited by \n.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	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:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always writeOffTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account, customer).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Common to all transaction types.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	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 Required	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"
        }
      ]
    }
  }
}