increase-test
POST/simulations/interest_payments

Sandbox: Create an interest payment

Simulates an interest payment to your account. In production, this happens automatically on the first of each month.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

5 body fields
account_idstringrequired
The identifier of the Account the Interest Payment should be paid to.
accrued_on_account_idstringoptional
The identifier of the Account the Interest accrued on. Defaults to `account_id`.
amountintegerrequired
The interest amount in cents. Must be positive.
period_endstringoptional
The end of the interest period. If not provided, defaults to the current time.
period_startstringoptional
The start of the interest period. If not provided, defaults to the current time.

3 status codes
200Transaction
account_idstringrequired
The identifier for the Account the Transaction belongs to.
amountintegerrequired
The Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Transaction occurred.
currencystringrequired
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Transaction's currency. This will match the currency on the Transaction's Account.
Allowed:USD
descriptionstringrequired
An informational message describing this transaction. Use the fields in `source` to get more detailed information. This field appears as the line-item on the statement.
idstringrequired
The Transaction identifier.
route_idstringrequired
The identifier for the route this Transaction came through. Routes are things like cards and ACH details.
route_typestringrequired
The type of the route this Transaction came through.
Allowed:account_numbercardlockbox
sourceobjectrequired
This is an object giving more details on the network-level event that caused the Transaction. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.
typestringrequired
A constant representing the object's type. For this resource it will always be `transaction`.
Allowed:transaction
4XXError
5XXError