Skip to main content
Ready-to-LaunchCustom Builds
Start Building Now

Resources

Book Payment​

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

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

Attributes​

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

Relationships​

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

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

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

Attributes​

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

Relationships​

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