POST

Simulate a billing-cycle close

ENDPOINT/v1/simulate/wallets/{wallet_id}/close-cycle

Closes the current billing cycle for a sandbox wallet, posts interest, and creates a statement. Equivalent to the credit engine firing when the virtual clock crosses billing_cycle_day. Served only on the sandbox host.

Authentication & Headers

Header	Type	Requirement	Description
Authorization	string	REQUIRED	API key passed as an HTTP Bearer token: `Bearer rk_live_...`
X-Program-ID	UUID	PROGRAM-SCOPED	Program boundary UUID that scopes the issuing card, wallet, or transfer.
Content-Type	string	REQUIRED	Must be `application/json`.
Idempotency-Key	string	OPTIONAL	Unique UUID to prevent duplicate execution of financial creations or mutations.

Path Parameters

Parameter	Type	Requirement	Description
wallet_id	string	REQUIRED	Unique identifier of the wallet.

Response Codes & Schemas

201The statement created by the cycle close.

application/json

{
  "id": "5a2c9e18-3d7f-4b60-8e1a-6c4f0d9b5821",
  "object": "statement",
  "wallet_id": "4d8f2a10-6c3e-4b91-9e5a-2f7c8d1e0b44",
  "period_start": "2026-07-16",
  "period_end": "2026-08-15",
  "statement_date": "2026-08-15",
  "payment_due_date": "2026-09-10",
  "previous_balance": {
    "amount": 432150,
    "currency": "USD"
  },
  "new_balance": {
    "amount": 445000,
    "currency": "USD"
  },
  "minimum_payment": {
    "amount": 2500,
    "currency": "USD"
  },
  "credit_limit": {
    "amount": 500000,
    "currency": "USD"
  },
  "available_credit": {
    "amount": 55000,
    "currency": "USD"
  },
  "ytd_totals": {
    "interest": {
      "amount": 18750,
      "currency": "USD"
    },
    "fees": {
      "amount": 3500,
      "currency": "USD"
    },
    "purchases": {
      "amount": 1250000,
      "currency": "USD"
    },
    "payments": {
      "amount": 980000,
      "currency": "USD"
    }
  },
  "interest_details": {
    "apr": 2499,
    "daily_balance_amounts": [
      {
        "date": "2026-07-16",
        "amount": {
          "amount": 432150,
          "currency": "USD"
        }
      },
      {
        "date": "2026-08-15",
        "amount": {
          "amount": 445000,
          "currency": "USD"
        }
      }
    ]
  },
  "wallet_standing": {
    "period_state": "CURRENT",
    "days_past_due": 0,
    "consecutive_minimum_payments_missed": 0
  },
  "created_at": "2026-08-16T05:05:00Z",
  "updated_at": "2026-08-16T05:05:00Z"
}

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"
  }
}