BYbyaccrue
Simulations

Simulate Counterparty Deposit

Simulate an incoming ACH credit or debit on a counterparty's Accrue deposit account.

Use this to credit or debit a counterparty in development, sandbox, and local environments without sending a real ACH or wire. Set direction to debit to simulate an inbound ACH debit; a debit larger than the counterparty's balance takes the balance negative.

A CounterpartyIncomingPayment webhook fires with the matching direction once the payment is processed.

Set originatorName and description to control what the deposit carries in those fields, for example to test matching an inbound payout to its source. They are limited to the ACH lengths, 16 and 10 characters.

The request is accepted immediately. The counterparty balance updates asynchronously after the incoming payment is processed, so a subsequent read may briefly show the previous balance.

The counterparty must already have an Accrue deposit account (internalBankAccount on the counterparty resource). Counterparties without one cannot receive simulated deposits.

See Simulating inbound ACH credits and debits for a walkthrough.

This endpoint is only available in development, sandbox, and local testing environments.

post/api/v1/simulation/counterparties/{counterpartyId}/deposits

Request

Path parameters

counterpartyIdstring uuid required

Counterparty ID

Example:123e4567-e89b-12d3-a456-426614174000

Headers

Client-IDstring uuid required

The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.

Example:123e4567-e89b-12d3-a456-426614174000
Authorizationstring uuid required

Secure secret to access privileged endpoints.

Example:Bearer 633b336e4f57f095a405f6685e208cc7dd16de3e82494662f2acfeec3af1cdef

Request body

Example request

{
  "data": {
    "attributes": {
      "amount": 10000,
      "direction": "credit",
      "originatorName": "STRIPE",
      "description": "TRANSFER"
    }
  }
}

Response

No Content - Deposit simulation accepted

Changes

No recorded changes to this operation across all 1 revision of this API.