ROOKDocs
Sign In
POST

Simulate an ACH payment action

ENDPOINT/v1/simulate/payments/{payment_id}/action

Injects a specific ACH rail event onto an existing sandbox Payment. event_type selects the network message (ACH_ORIGINATION_SETTLED, ACH_RECEIPT_SETTLED, ACH_RETURN_INITIATED, and the rest of the closed set). Settlement values append a SETTLED event and set Payment status SETTLED. Return values append RETURNED and set status RETURNED. Review, release, and processed values leave status PENDING. Platform events: transaction.updated and, when funds post or unwind, balance.updated. Served only on the sandbox host.

Authentication & Headers

HeaderTypeRequirementDescription
AuthorizationstringREQUIREDAPI key passed as an HTTP Bearer token: Bearer rk_live_...
X-Program-IDUUIDPROGRAM-SCOPEDProgram boundary UUID that scopes the issuing card, wallet, or transfer.
Content-TypestringREQUIREDMust be application/json.
Idempotency-KeystringOPTIONALUnique UUID to prevent duplicate execution of financial creations or mutations.

Path Parameters

ParameterTypeRequirementDescription
payment_idstringREQUIREDUnique identifier of the PAYMENT transaction (its transaction id).

Request Body Schema

application/json
event_typestring
REQUIRED

ACH network message to inject onto an existing Payment. Origination values apply to integrator-originated ACH. Receipt values apply to inbound ACH created with `POST /v1/simulate/payments/receipt`. Return values unwind a settlement. The Payment `events[]` log still uses `CREATED`, `SETTLED`, and `RETURNED`; this field names the rail event being simulated.

Enum values:ACH_ORIGINATION_REVIEWEDACH_ORIGINATION_RELEASEDACH_ORIGINATION_PROCESSEDACH_ORIGINATION_SETTLEDACH_ORIGINATION_RETURNEDACH_RECEIPT_SETTLEDACH_RECEIPT_RETURN_INITIATEDACH_RETURN_INITIATEDACH_RETURN_PROCESSED

Response Codes & Schemas

200The Payment after the ACH rail event was applied.
application/json
{
  "id": "8f1a4c60-2e7b-4d23-c0f5-7a0d3e9c4576",
  "object": "transaction",
  "type": "PAYMENT",
  "status": "SETTLED",
  "transfer_ids": [
    "6f2d8a41-3c7e-4b95-a1d0-8e5c2f7b9a63"
  ],
  "amount": {
    "amount": 125000,
    "currency": "USD"
  },
  "wallet_id": "4d8f2a10-6c3e-4b91-9e5a-2f7c8d1e0b44",
  "financial_account_id": "9b3e1c70-4d2a-4f86-8c1b-5e7a2d9f0c14",
  "direction": "CREDIT",
  "category": "ACH",
  "memo": "ACH autopay collection",
  "events": [
    {
      "id": "3a6c8d14-5b91-4e24-f7a0-4d2b9c3e6175",
      "type": "CREATED",
      "amount": {
        "amount": 125000,
        "currency": "USD"
      },
      "result": "APPROVED",
      "financial_account_id": "9b3e1c70-4d2a-4f86-8c1b-5e7a2d9f0c14",
      "created_at": "2026-08-20T12:00:00Z"
    },
    {
      "id": "4b7d9e25-6c02-4f35-a8b1-5e3c0d4f7286",
      "type": "SETTLED",
      "amount": {
        "amount": 125000,
        "currency": "USD"
      },
      "result": "APPROVED",
      "financial_account_id": "9b3e1c70-4d2a-4f86-8c1b-5e7a2d9f0c14",
      "created_at": "2026-08-22T16:05:00Z"
    }
  ],
  "created_at": "2026-08-20T12:00:00Z",
  "updated_at": "2026-08-22T16:05:00Z",
  "external_bank_account_id": "1b6d8f20-4c53-4a87-9e2d-0f5a7c8b3914",
  "method": "ACH_NEXT_DAY",
  "sec_code": "PPD",
  "payment_type": "PAYIN",
  "result": "APPROVED",
  "return_reason_code": null
}
400Bad Request: malformed JSON, failed schema validation, or conflicting parameters.
application/json
{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_request",
    "message": "invalid order by: foo. Valid options are: [created_at updated_at]",
    "param": "order_by",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/invalid_request"
  }
}
401Unauthorized: missing, malformed, or unknown API key.
application/json
{
  "error": {
    "type": "authentication_error",
    "code": "authentication_error",
    "message": "A valid API key is required.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/authentication_error"
  }
}
403Forbidden: the API key is denied by RBAC, or it cannot access this program. A resource that exists on another program or organization returns `404 not_found`, not `403`.
application/json
{
  "error": {
    "type": "permission_error",
    "code": "permission_denied",
    "message": "The API key cannot access this program.",
    "param": "X-Program-ID",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/permission_denied"
  }
}
404Not Found: unknown id, or the resource is not visible to this API key.
application/json
{
  "error": {
    "type": "not_found_error",
    "code": "not_found",
    "message": "No card found for the given id.",
    "param": "card_id",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/not_found"
  }
}
409Conflict: incompatible state, or Idempotency-Key reused with a different body.
application/json
{
  "error": {
    "type": "conflict_error",
    "code": "conflict",
    "message": "The card cannot be reissued from its current state.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/conflict"
  }
}
422Unprocessable Entity: the document is valid JSON but violates a business rule.
application/json
{
  "error": {
    "type": "invalid_request_error",
    "code": "insufficient_funds",
    "message": "The source financial account does not have enough available balance.",
    "param": "amount",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/insufficient_funds"
  }
}
429Too Many Requests: the API key exceeded its rate limit.
application/json
{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limited",
    "message": "Rate limit exceeded. Retry after the number of seconds in Retry-After.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/rate_limited"
  }
}
500Internal Server Error: unexpected failure. Retry with the same Idempotency-Key.
application/json
{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected error occurred. Retry with the same Idempotency-Key.",
    "param": null,
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "doc_url": "https://docs.rookpayments.com/errors/internal_error"
  }
}