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

Resources

Recurring Credit ACH Payment​

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

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

Attributes​

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

Relationships​

account
JSON:API Relationship
The Deposit Account originating the recurring payment.
org
JSON:API Relationship
The org the customer belongs to.
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.
counterparty
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 Debit ACH Payment​

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

id
string
Identifier of the recurring Debit ACH payment resource.
type
string
Type of the payment resource. For debit ach recurring payments the value is recurringDebitAchPayment.
attributes
JSON Object
JSON object representing the recurring payment resource.
relationships
JSON:API Relationships
Describes relationships between the Recurring Debit ACH payment and the originating deposit account and org.

Attributes​

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

Relationships​

account
JSON:API Relationship
The Deposit Account originating the recurring payment.
org
JSON:API Relationship
The org the customer belongs to.
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.
counterparty
JSON:API Relationship
The Counterparty the payment to be made to.
Example RecurringDebitAchPayment 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"
        }
      }
    }
  }
}

Recurring Credit Book Payment​

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

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

Attributes​

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

Relationships​

account
JSON:API Relationship
The Deposit Account creating the recurring payment.
counterpartyAccount
JSON:API Relationship
The Counterparty account the payment to be made to.
org
JSON:API Relationship
The org the customer belongs to.
customer
Optional, JSON:API Relationship
The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
Example RecurringBookPayment resource:
{
  "data": {
    "type": "recurringCreditBookPayment",
    "id": "4",
    "attributes": {
      "createdAt": "2022-06-25T14:27:41.093Z",
      "updatedAt": "2022-06-25T14:27:41.093Z",
      "amount": 40,
      "description": "Subscription - Basic Plan",
      "schedule": {
        "startTime": "2022-06-25",
        "interval": "Monthly",
        "nextScheduledAction": "2022-07-05",
        "dayOfMonth": 5
      },
      "status": "Active",
      "tags": {
        "test": "test"
      },
      "numberOfPayments": 0
    },
    "relationships": {
      "org": {
        "data": {
          "type": "org",
          "id": "1"
        }
      },
      "account": {
        "data": {
          "type": "account",
          "id": "10002"
        }
      },
      "counterpartyAccount": {
        "data": {
          "type": "account",
          "id": "10000"
        }
      },
      "customer": {
        "data": {
          "type": "customer",
          "id": "10004"
        }
      }
    }
  }
}